Replace working hours

PUT

/v1/working_hours

curl --fail-with-body -X PUT 'https://api.talki.it/v1/working_hours' \
  -H "Authorization: Bearer $TALKI_API_KEY" \
  -H "Idempotency-Key: hours-2026-10" \
  -H "Content-Type: application/json" \
  --data '{"slots":[{"days":[2,3,4,5],"start":"09:00","end":"13:00"},{"days":[2,3,4,5],"start":"14:30","end":"19:00"},{"days":[6],"start":"09:00","end":"17:00"}]}'

• Production

Replace one location’s whole weekly schedule, the main location’s unless location_id names another. GET /v1/availability and the assistant use the new hours at once. Requires account:write. Limited to 120 requests per minute per account (API key) or per installation (OAuth).

Authorizations

• ApiKeyAuth

Parameters

Query Parameters

location_id

Any of:

string

string

null

null

The location whose weekly hours to replace, an id from GET /v1/locations (inactive ones included). Omit it for the main location.

Header Parameters

Talki-Version

string

Example

2026-10-01

Serve this one request at the given dated contract version instead of the credential’s pin. An unsupported value is refused with 400 unsupported_version, never downgraded.

Idempotency-Key

string

<= 255 characters

Unique key for this logical write. Reuse it only when retrying the same method, path, query and body. Required on appointment writes, on creating a service, a resource, a closure, a tag, a caller rule or a document, and on teaching the assistant; optional on every other write. Retained for 24 hours: a retry with the same key gets the first response again, marked Idempotency-Replayed: true, and a refusal that holds until the state changes (a time taken, a list full) is replayed too. A response a retry can change is not kept when the request saved nothing, and the retry runs the request again: a 400 asking for a different request (invalid_parameter, invalid_cursor, export_too_large, unknown_scenario, no_services_requested, stay_too_short, stay_too_long, stay_dates_invalid), a 415, a 409 request_conflict, document_not_ready or check_in_progress, a 412, a 429 and a 5xx.

Example

hours-2026-10

If-Match

string

The ETag of your last read. If the stored version is a different one, the write is refused with 412 precondition_failed, unless it asks for exactly what is already stored, so retrying a write that succeeded is safe. * always matches; a weak tag (W/…) never does. Without it, the write replaces whatever is stored.

Example

"9c1e4b7a2f0d4c68b35e7a1d9f2c6b40"

Request Body^required

Media typeapplication/json

WorkingHoursUpdate

The whole week, replacing the current schedule. A slot you leave out is an opening removed, so read the hours first and send them back changed.

object

slots

required

Slots

The whole week, replacing every existing slot. A slot left out is an opening removed. Send an empty list to remove all regular hours.

Array<object>

<= 20 items

WorkingHoursSlot

One weekly opening: a time range, in the account’s timezone, on one or more weekdays.

object

days

required

Days

Weekdays this range applies to, as ISO weekday numbers: 1 is Monday, 7 is Sunday.

Array<integer>

>= 1 items <= 7 items

start

required

Start

Opening time, HH:MM in the account’s timezone.

string

/^([01]\d|2[0-3]):[0-5]\d$/

end

required

End

Closing time, HH:MM in the account’s timezone. Must be after start: a range cannot cross midnight, so split one that does into two slots on consecutive days.

string

/^([01]\d|2[0-3]):[0-5]\d$/

Example

{
  "slots": [
    {
      "days": [
        2,
        3,
        4,
        5
      ],
      "start": "09:00",
      "end": "13:00"
    },
    {
      "days": [
        2,
        3,
        4,
        5
      ],
      "start": "14:30",
      "end": "19:00"
    },
    {
      "days": [
        6
      ],
      "start": "09:00",
      "end": "17:00"
    }
  ]
}

Responses

200

Successful Response

Media typeapplication/json

WorkingHours

One location’s regular weekly opening hours, the main one unless ?location_id= names another: what the assistant offers that location’s callers and what GET /v1/availability is computed from for its services. Dated exceptions are Closure objects. The response’s ETag goes back as If-Match on PUT /v1/working_hours with the same location_id.

object

location_id

required

Location Id

The location these are the hours of, an id from GET /v1/locations: the one the request named with location_id, or the main location when it named none.

string

slots

required

Slots

Every weekly opening. A day with a lunch break has two slots. An empty list means the business has no regular opening hours, so the assistant offers callers no regular time to book.

Array<object>

WorkingHoursSlot

One weekly opening: a time range, in the account’s timezone, on one or more weekdays.

object

days

required

Days

Weekdays this range applies to, as ISO weekday numbers: 1 is Monday, 7 is Sunday.

Array<integer>

>= 1 items <= 7 items

start

required

Start

Opening time, HH:MM in the account’s timezone.

string

/^([01]\d|2[0-3]):[0-5]\d$/

end

required

End

Closing time, HH:MM in the account’s timezone. Must be after start: a range cannot cross midnight, so split one that does into two slots on consecutive days.

string

/^([01]\d|2[0-3]):[0-5]\d$/

Example

{
  "location_id": "0b7d4e19-8a2c-4f61-9d3e-5c1a7b2f8e40",
  "slots": [
    {
      "days": [
        2,
        3,
        4,
        5
      ],
      "start": "09:00",
      "end": "13:00"
    },
    {
      "days": [
        2,
        3,
        4,
        5
      ],
      "start": "14:30",
      "end": "19:00"
    },
    {
      "days": [
        6
      ],
      "start": "09:00",
      "end": "17:00"
    }
  ]
}

Headers

X-Request-Id

string

Identifier to include when contacting Talki support.

Talki-Version

string

Example

2026-10-01

The dated contract version this response was served at.

ETag

string

Example

"9c1e4b7a2f0d4c68b35e7a1d9f2c6b40"

Strong entity tag of the writable content. Send it as If-Match on the next write. Absent on a response replayed from an Idempotency-Key; read again for a current one.

Idempotency-Replayed

string

Allowed values: true

true when this response was replayed from a prior request with the same key.

400

A parameter, cursor, body field, or required idempotency key is invalid, or Talki-Version names an unsupported version (unsupported_version).

Media typeapplication/json

Every error answer has this shape.

object

error

required

The error itself. Branch on code; message is for people.

object

type

required

string

Allowed values: authentication_error permission_error invalid_request conflict rate_limit_error api_error

code

required

Stable machine code; branch on this, not on message. Known codes: invalid_credentials, insufficient_scope, account_closed, subscription_inactive, plan_upgrade_required, plan_feature_unavailable, forbidden, livemode_required, sandbox_api_key_required, unsupported_version, invalid_parameter, invalid_cursor, method_not_allowed, resource_not_found, conflict, precondition_failed, payload_too_large, export_too_large, idempotency_key_required, idempotency_key_reuse, request_in_progress, request_conflict, rate_limit_exceeded, ip_rate_limited, internal_error, api_error, booking_refused, appointment_cancelled, appointment_not_cancelled, unresolved_request_not_resolved, faq_full, document_not_ready, unsupported_file_type, service_has_upcoming_bookings, resource_is_default, resource_required_by_service, capacity_below_committed, capacity_below_service_requirement, resource_too_small, tag_limit_reached, caller_rule_limit_reached, transcript_not_available, trial_suspended, account_suspended, phone_number_missing, forwarding_number_missing, forwarding_number_invalid, check_in_progress, check_quota_exceeded, checks_busy, check_call_failed, agent_test_session_full, agent_test_unavailable, unknown_scenario, sandbox_not_ready, too_many_keys, key_not_active, key_already_rolled, invalid_registration, client_disabled, client_changed, delivery_in_progress, events_url_unset, events_paused, event_unsubscribed, account_refused, installation_inactive, invalid_client, invalid_request, unauthorized_client, access_denied, invalid_scope, slot_unavailable, capacity_exhausted, service_exclusion, closed_day, in_the_past, outside_hours, service_inactive, location_inactive, service_deleted, no_services_requested, party_too_large, stay_too_short, stay_too_long, stay_dates_invalid. New codes may be added; treat an unknown one by its HTTP status.

string

message

required

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request",
    "code": "invalid_parameter",
    "message": "One or more request values are invalid.",
    "request_id": "req_7f24a2f8c6b64e699901563a458b5031"
  }
}

Headers

X-Request-Id

string

Example

req_7f24a2f8c6b64e699901563a458b5031

Identifier to include when contacting Talki support.

401

The credential is missing, malformed, expired, revoked, or unknown.

Media typeapplication/json

Every error answer has this shape.

object

error

required

The error itself. Branch on code; message is for people.

object

type

required

string

Allowed values: authentication_error permission_error invalid_request conflict rate_limit_error api_error

code

required

Stable machine code; branch on this, not on message. Known codes: invalid_credentials, insufficient_scope, account_closed, subscription_inactive, plan_upgrade_required, plan_feature_unavailable, forbidden, livemode_required, sandbox_api_key_required, unsupported_version, invalid_parameter, invalid_cursor, method_not_allowed, resource_not_found, conflict, precondition_failed, payload_too_large, export_too_large, idempotency_key_required, idempotency_key_reuse, request_in_progress, request_conflict, rate_limit_exceeded, ip_rate_limited, internal_error, api_error, booking_refused, appointment_cancelled, appointment_not_cancelled, unresolved_request_not_resolved, faq_full, document_not_ready, unsupported_file_type, service_has_upcoming_bookings, resource_is_default, resource_required_by_service, capacity_below_committed, capacity_below_service_requirement, resource_too_small, tag_limit_reached, caller_rule_limit_reached, transcript_not_available, trial_suspended, account_suspended, phone_number_missing, forwarding_number_missing, forwarding_number_invalid, check_in_progress, check_quota_exceeded, checks_busy, check_call_failed, agent_test_session_full, agent_test_unavailable, unknown_scenario, sandbox_not_ready, too_many_keys, key_not_active, key_already_rolled, invalid_registration, client_disabled, client_changed, delivery_in_progress, events_url_unset, events_paused, event_unsubscribed, account_refused, installation_inactive, invalid_client, invalid_request, unauthorized_client, access_denied, invalid_scope, slot_unavailable, capacity_exhausted, service_exclusion, closed_day, in_the_past, outside_hours, service_inactive, location_inactive, service_deleted, no_services_requested, party_too_large, stay_too_short, stay_too_long, stay_dates_invalid. New codes may be added; treat an unknown one by its HTTP status.

string

message

required

string

request_id

required

string

Example

{
  "error": {
    "type": "authentication_error",
    "code": "invalid_credentials",
    "message": "The supplied API credential is invalid.",
    "request_id": "req_7f24a2f8c6b64e699901563a458b5031"
  }
}

Headers

X-Request-Id

string

Example

req_7f24a2f8c6b64e699901563a458b5031

Identifier to include when contacting Talki support.

402

The account does not have an active subscription.

Media typeapplication/json

Every error answer has this shape.

object

error

required

The error itself. Branch on code; message is for people.

object

type

required

string

Allowed values: authentication_error permission_error invalid_request conflict rate_limit_error api_error

code

required

Stable machine code; branch on this, not on message. Known codes: invalid_credentials, insufficient_scope, account_closed, subscription_inactive, plan_upgrade_required, plan_feature_unavailable, forbidden, livemode_required, sandbox_api_key_required, unsupported_version, invalid_parameter, invalid_cursor, method_not_allowed, resource_not_found, conflict, precondition_failed, payload_too_large, export_too_large, idempotency_key_required, idempotency_key_reuse, request_in_progress, request_conflict, rate_limit_exceeded, ip_rate_limited, internal_error, api_error, booking_refused, appointment_cancelled, appointment_not_cancelled, unresolved_request_not_resolved, faq_full, document_not_ready, unsupported_file_type, service_has_upcoming_bookings, resource_is_default, resource_required_by_service, capacity_below_committed, capacity_below_service_requirement, resource_too_small, tag_limit_reached, caller_rule_limit_reached, transcript_not_available, trial_suspended, account_suspended, phone_number_missing, forwarding_number_missing, forwarding_number_invalid, check_in_progress, check_quota_exceeded, checks_busy, check_call_failed, agent_test_session_full, agent_test_unavailable, unknown_scenario, sandbox_not_ready, too_many_keys, key_not_active, key_already_rolled, invalid_registration, client_disabled, client_changed, delivery_in_progress, events_url_unset, events_paused, event_unsubscribed, account_refused, installation_inactive, invalid_client, invalid_request, unauthorized_client, access_denied, invalid_scope, slot_unavailable, capacity_exhausted, service_exclusion, closed_day, in_the_past, outside_hours, service_inactive, location_inactive, service_deleted, no_services_requested, party_too_large, stay_too_short, stay_too_long, stay_dates_invalid. New codes may be added; treat an unknown one by its HTTP status.

string

message

required

string

request_id

required

string

Example

{
  "error": {
    "type": "permission_error",
    "code": "subscription_inactive",
    "message": "This account does not have an active subscription.",
    "request_id": "req_7f24a2f8c6b64e699901563a458b5031"
  }
}

Headers

X-Request-Id

string

Example

req_7f24a2f8c6b64e699901563a458b5031

Identifier to include when contacting Talki support.

403

The account or credential may not perform this request.

Media typeapplication/json

Every error answer has this shape.

object

error

required

The error itself. Branch on code; message is for people.

object

type

required

string

Allowed values: authentication_error permission_error invalid_request conflict rate_limit_error api_error

code

required

Stable machine code; branch on this, not on message. Known codes: invalid_credentials, insufficient_scope, account_closed, subscription_inactive, plan_upgrade_required, plan_feature_unavailable, forbidden, livemode_required, sandbox_api_key_required, unsupported_version, invalid_parameter, invalid_cursor, method_not_allowed, resource_not_found, conflict, precondition_failed, payload_too_large, export_too_large, idempotency_key_required, idempotency_key_reuse, request_in_progress, request_conflict, rate_limit_exceeded, ip_rate_limited, internal_error, api_error, booking_refused, appointment_cancelled, appointment_not_cancelled, unresolved_request_not_resolved, faq_full, document_not_ready, unsupported_file_type, service_has_upcoming_bookings, resource_is_default, resource_required_by_service, capacity_below_committed, capacity_below_service_requirement, resource_too_small, tag_limit_reached, caller_rule_limit_reached, transcript_not_available, trial_suspended, account_suspended, phone_number_missing, forwarding_number_missing, forwarding_number_invalid, check_in_progress, check_quota_exceeded, checks_busy, check_call_failed, agent_test_session_full, agent_test_unavailable, unknown_scenario, sandbox_not_ready, too_many_keys, key_not_active, key_already_rolled, invalid_registration, client_disabled, client_changed, delivery_in_progress, events_url_unset, events_paused, event_unsubscribed, account_refused, installation_inactive, invalid_client, invalid_request, unauthorized_client, access_denied, invalid_scope, slot_unavailable, capacity_exhausted, service_exclusion, closed_day, in_the_past, outside_hours, service_inactive, location_inactive, service_deleted, no_services_requested, party_too_large, stay_too_short, stay_too_long, stay_dates_invalid. New codes may be added; treat an unknown one by its HTTP status.

string

message

required

string

request_id

required

string

Example

{
  "error": {
    "type": "permission_error",
    "code": "insufficient_scope",
    "message": "This credential does not have the required scope.",
    "request_id": "req_7f24a2f8c6b64e699901563a458b5031"
  }
}

Headers

X-Request-Id

string

Example

req_7f24a2f8c6b64e699901563a458b5031

Identifier to include when contacting Talki support.

404

location_id names no location of the authenticated account.

Media typeapplication/json

Every error answer has this shape.

object

error

required

The error itself. Branch on code; message is for people.

object

type

required

string

Allowed values: authentication_error permission_error invalid_request conflict rate_limit_error api_error

code

required

Stable machine code; branch on this, not on message. Known codes: invalid_credentials, insufficient_scope, account_closed, subscription_inactive, plan_upgrade_required, plan_feature_unavailable, forbidden, livemode_required, sandbox_api_key_required, unsupported_version, invalid_parameter, invalid_cursor, method_not_allowed, resource_not_found, conflict, precondition_failed, payload_too_large, export_too_large, idempotency_key_required, idempotency_key_reuse, request_in_progress, request_conflict, rate_limit_exceeded, ip_rate_limited, internal_error, api_error, booking_refused, appointment_cancelled, appointment_not_cancelled, unresolved_request_not_resolved, faq_full, document_not_ready, unsupported_file_type, service_has_upcoming_bookings, resource_is_default, resource_required_by_service, capacity_below_committed, capacity_below_service_requirement, resource_too_small, tag_limit_reached, caller_rule_limit_reached, transcript_not_available, trial_suspended, account_suspended, phone_number_missing, forwarding_number_missing, forwarding_number_invalid, check_in_progress, check_quota_exceeded, checks_busy, check_call_failed, agent_test_session_full, agent_test_unavailable, unknown_scenario, sandbox_not_ready, too_many_keys, key_not_active, key_already_rolled, invalid_registration, client_disabled, client_changed, delivery_in_progress, events_url_unset, events_paused, event_unsubscribed, account_refused, installation_inactive, invalid_client, invalid_request, unauthorized_client, access_denied, invalid_scope, slot_unavailable, capacity_exhausted, service_exclusion, closed_day, in_the_past, outside_hours, service_inactive, location_inactive, service_deleted, no_services_requested, party_too_large, stay_too_short, stay_too_long, stay_dates_invalid. New codes may be added; treat an unknown one by its HTTP status.

string

message

required

string

request_id

required

string

Example

{
  "error": {
    "type": "invalid_request",
    "code": "resource_not_found",
    "message": "No such location.",
    "request_id": "req_7f24a2f8c6b64e699901563a458b5031"
  }
}

Headers

X-Request-Id

string

Example

req_7f24a2f8c6b64e699901563a458b5031

Identifier to include when contacting Talki support.

409

The write conflicts with current state or a previous idempotency key use.

Media typeapplication/json

Every error answer has this shape.

object

error

required

The error itself. Branch on code; message is for people.

object

type

required

string

Allowed values: authentication_error permission_error invalid_request conflict rate_limit_error api_error

code

required

Stable machine code; branch on this, not on message. Known codes: invalid_credentials, insufficient_scope, account_closed, subscription_inactive, plan_upgrade_required, plan_feature_unavailable, forbidden, livemode_required, sandbox_api_key_required, unsupported_version, invalid_parameter, invalid_cursor, method_not_allowed, resource_not_found, conflict, precondition_failed, payload_too_large, export_too_large, idempotency_key_required, idempotency_key_reuse, request_in_progress, request_conflict, rate_limit_exceeded, ip_rate_limited, internal_error, api_error, booking_refused, appointment_cancelled, appointment_not_cancelled, unresolved_request_not_resolved, faq_full, document_not_ready, unsupported_file_type, service_has_upcoming_bookings, resource_is_default, resource_required_by_service, capacity_below_committed, capacity_below_service_requirement, resource_too_small, tag_limit_reached, caller_rule_limit_reached, transcript_not_available, trial_suspended, account_suspended, phone_number_missing, forwarding_number_missing, forwarding_number_invalid, check_in_progress, check_quota_exceeded, checks_busy, check_call_failed, agent_test_session_full, agent_test_unavailable, unknown_scenario, sandbox_not_ready, too_many_keys, key_not_active, key_already_rolled, invalid_registration, client_disabled, client_changed, delivery_in_progress, events_url_unset, events_paused, event_unsubscribed, account_refused, installation_inactive, invalid_client, invalid_request, unauthorized_client, access_denied, invalid_scope, slot_unavailable, capacity_exhausted, service_exclusion, closed_day, in_the_past, outside_hours, service_inactive, location_inactive, service_deleted, no_services_requested, party_too_large, stay_too_short, stay_too_long, stay_dates_invalid. New codes may be added; treat an unknown one by its HTTP status.

string

message

required

string

request_id

required

string

Example

{
  "error": {
    "type": "conflict",
    "code": "idempotency_key_reuse",
    "message": "This Idempotency-Key was already used for a different request.",
    "request_id": "req_7f24a2f8c6b64e699901563a458b5031"
  }
}

Headers

X-Request-Id

string

Example

req_7f24a2f8c6b64e699901563a458b5031

Identifier to include when contacting Talki support.

412

If-Match names a version other than the stored one: the settings changed since you read them. Read them again, reapply your change, and retry with the new ETag.

Media typeapplication/json

Every error answer has this shape.

object

error

required

The error itself. Branch on code; message is for people.

object

type

required

string

Allowed values: authentication_error permission_error invalid_request conflict rate_limit_error api_error

code

required

Stable machine code; branch on this, not on message. Known codes: invalid_credentials, insufficient_scope, account_closed, subscription_inactive, plan_upgrade_required, plan_feature_unavailable, forbidden, livemode_required, sandbox_api_key_required, unsupported_version, invalid_parameter, invalid_cursor, method_not_allowed, resource_not_found, conflict, precondition_failed, payload_too_large, export_too_large, idempotency_key_required, idempotency_key_reuse, request_in_progress, request_conflict, rate_limit_exceeded, ip_rate_limited, internal_error, api_error, booking_refused, appointment_cancelled, appointment_not_cancelled, unresolved_request_not_resolved, faq_full, document_not_ready, unsupported_file_type, service_has_upcoming_bookings, resource_is_default, resource_required_by_service, capacity_below_committed, capacity_below_service_requirement, resource_too_small, tag_limit_reached, caller_rule_limit_reached, transcript_not_available, trial_suspended, account_suspended, phone_number_missing, forwarding_number_missing, forwarding_number_invalid, check_in_progress, check_quota_exceeded, checks_busy, check_call_failed, agent_test_session_full, agent_test_unavailable, unknown_scenario, sandbox_not_ready, too_many_keys, key_not_active, key_already_rolled, invalid_registration, client_disabled, client_changed, delivery_in_progress, events_url_unset, events_paused, event_unsubscribed, account_refused, installation_inactive, invalid_client, invalid_request, unauthorized_client, access_denied, invalid_scope, slot_unavailable, capacity_exhausted, service_exclusion, closed_day, in_the_past, outside_hours, service_inactive, location_inactive, service_deleted, no_services_requested, party_too_large, stay_too_short, stay_too_long, stay_dates_invalid. New codes may be added; treat an unknown one by its HTTP status.

string

message

required

string

request_id

required

string

Example

{
  "error": {
    "type": "conflict",
    "code": "precondition_failed",
    "message": "This resource changed after the version named in If-Match. Fetch it again, reapply your change, and retry with the new ETag.",
    "request_id": "req_7f24a2f8c6b64e699901563a458b5031"
  }
}

Headers

X-Request-Id

string

Example

req_7f24a2f8c6b64e699901563a458b5031

Identifier to include when contacting Talki support.

429

The account or installation exceeded its request rate (rate_limit_exceeded), or the calling address did (ip_rate_limited).

Media typeapplication/json

Every error answer has this shape.

object

error

required

The error itself. Branch on code; message is for people.

object

type

required

string

Allowed values: authentication_error permission_error invalid_request conflict rate_limit_error api_error

code

required

Stable machine code; branch on this, not on message. Known codes: invalid_credentials, insufficient_scope, account_closed, subscription_inactive, plan_upgrade_required, plan_feature_unavailable, forbidden, livemode_required, sandbox_api_key_required, unsupported_version, invalid_parameter, invalid_cursor, method_not_allowed, resource_not_found, conflict, precondition_failed, payload_too_large, export_too_large, idempotency_key_required, idempotency_key_reuse, request_in_progress, request_conflict, rate_limit_exceeded, ip_rate_limited, internal_error, api_error, booking_refused, appointment_cancelled, appointment_not_cancelled, unresolved_request_not_resolved, faq_full, document_not_ready, unsupported_file_type, service_has_upcoming_bookings, resource_is_default, resource_required_by_service, capacity_below_committed, capacity_below_service_requirement, resource_too_small, tag_limit_reached, caller_rule_limit_reached, transcript_not_available, trial_suspended, account_suspended, phone_number_missing, forwarding_number_missing, forwarding_number_invalid, check_in_progress, check_quota_exceeded, checks_busy, check_call_failed, agent_test_session_full, agent_test_unavailable, unknown_scenario, sandbox_not_ready, too_many_keys, key_not_active, key_already_rolled, invalid_registration, client_disabled, client_changed, delivery_in_progress, events_url_unset, events_paused, event_unsubscribed, account_refused, installation_inactive, invalid_client, invalid_request, unauthorized_client, access_denied, invalid_scope, slot_unavailable, capacity_exhausted, service_exclusion, closed_day, in_the_past, outside_hours, service_inactive, location_inactive, service_deleted, no_services_requested, party_too_large, stay_too_short, stay_too_long, stay_dates_invalid. New codes may be added; treat an unknown one by its HTTP status.

string

message

required

string

request_id

required

string

Example

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Too many requests. Retry after the interval in Retry-After.",
    "request_id": "req_7f24a2f8c6b64e699901563a458b5031"
  }
}

Headers

X-Request-Id

string

Example

req_7f24a2f8c6b64e699901563a458b5031

Identifier to include when contacting Talki support.

Retry-After

integer

Seconds to wait before retrying.

X-RateLimit-Limit

string

The budget of the window that was exceeded. Absent on ip_rate_limited.

X-RateLimit-Remaining

integer

Requests left in the window. Absent on ip_rate_limited.

X-RateLimit-Reset

integer

When the window resets, in Unix seconds. Absent on ip_rate_limited.

500

An unexpected error occurred.

Media typeapplication/json

Every error answer has this shape.

object

error

required

The error itself. Branch on code; message is for people.

object

type

required

string

Allowed values: authentication_error permission_error invalid_request conflict rate_limit_error api_error

code

required

Stable machine code; branch on this, not on message. Known codes: invalid_credentials, insufficient_scope, account_closed, subscription_inactive, plan_upgrade_required, plan_feature_unavailable, forbidden, livemode_required, sandbox_api_key_required, unsupported_version, invalid_parameter, invalid_cursor, method_not_allowed, resource_not_found, conflict, precondition_failed, payload_too_large, export_too_large, idempotency_key_required, idempotency_key_reuse, request_in_progress, request_conflict, rate_limit_exceeded, ip_rate_limited, internal_error, api_error, booking_refused, appointment_cancelled, appointment_not_cancelled, unresolved_request_not_resolved, faq_full, document_not_ready, unsupported_file_type, service_has_upcoming_bookings, resource_is_default, resource_required_by_service, capacity_below_committed, capacity_below_service_requirement, resource_too_small, tag_limit_reached, caller_rule_limit_reached, transcript_not_available, trial_suspended, account_suspended, phone_number_missing, forwarding_number_missing, forwarding_number_invalid, check_in_progress, check_quota_exceeded, checks_busy, check_call_failed, agent_test_session_full, agent_test_unavailable, unknown_scenario, sandbox_not_ready, too_many_keys, key_not_active, key_already_rolled, invalid_registration, client_disabled, client_changed, delivery_in_progress, events_url_unset, events_paused, event_unsubscribed, account_refused, installation_inactive, invalid_client, invalid_request, unauthorized_client, access_denied, invalid_scope, slot_unavailable, capacity_exhausted, service_exclusion, closed_day, in_the_past, outside_hours, service_inactive, location_inactive, service_deleted, no_services_requested, party_too_large, stay_too_short, stay_too_long, stay_dates_invalid. New codes may be added; treat an unknown one by its HTTP status.

string

message

required

string

request_id

required

string

Example

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "An unexpected error occurred. Quote the request_id when reporting it.",
    "request_id": "req_7f24a2f8c6b64e699901563a458b5031"
  }
}

Headers

X-Request-Id

string

Example

req_7f24a2f8c6b64e699901563a458b5031

Identifier to include when contacting Talki support.