Create Service

This endpoint creates a service in the company catalog and assigns it to providers.

Important Notes

  • name, price and duration (minutes, 5 to 1439) are required.
  • Without service_category_id the service goes to the company's default category.
  • provider_ids and service_category_id must belong to the company.
  • online_payment is optional: by default, the service is not payable online (mode: NOT_AVAILABLE). An online mode requires the company to allow online payment.
  • Commission, tax, session and time-resource settings cannot be set through the public API; they take their upstream defaults (no commission).
  • The company is taken from the API key; company_id is never accepted.

Errors Dictionary

StatusErrorDetailDescription
400invalid_bodyexpected_objectRequest body is not a JSON object.
400invalid_name—name is blank or invalid.
400invalid_price—price is negative.
400invalid_duration—duration is out of range.
400invalid_online_payment_mode—online_payment.mode is invalid or not allowed for the company.
400invalid_online_payment_amount—online_payment.amount must be positive for MANDATORY_PARTIAL.
401unauthorizedinvalid_api_keyMissing or invalid Bearer token.
401unauthorizedapi_config_inactiveAPI access is inactive for this company.
403forbiddenscope_deniedAPI key lacks services:write scope.
403cross_company_service_category—service_category_id belongs to another company.
403cross_company_providers—A provider in provider_ids belongs to another company.
403outcall_not_supported—The company's plan does not allow at-home services.
403is_video_not_supported—The company's plan does not allow video services.
422inactive_providers—A provider in provider_ids is inactive.
422name_too_long—name exceeds 255 characters.
422invalid_service_categories—service_category_id was omitted and the company has no category to fall back to.
429rate_limitedburst_limit_exceededPer-minute request limit exceeded.
429rate_limiteddaily_quota_exceededDaily request quota exceeded.
502upstream_unavailableconnection_failedThe upstream service is unavailable.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Service fields writable through the public API.

string
required
length ≤ 255
string | null
integer

Category of the service. Must belong to the company.

number
required
≥ 0
integer
required
5 to 1439

Duration in minutes.

keywords
array of strings
length ≤ 10

Alternative names used by search (2 to 50 characters each).

keywords
provider_ids
array of integers

Providers that offer the service. Must belong to the company and be active.

provider_ids
boolean

Whether clients can book the service online.

online_payment
object

Online payment settings. Optional: on create, when omitted the service is not payable online (mode: NOT_AVAILABLE); on update, when omitted the current setting is kept.

boolean

Whether the booking site shows the price.

boolean

Whether the booking site shows the duration.

boolean

Whether the service is delivered by video call. Subject to the company's plan.

boolean

Whether the service is delivered at the client's address. Subject to the company's plan.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json