Skip to content
OnCoreDocs
Transfer Reasons

PATCHhttps://core-api.heysadie.ai/transfer-reasons/{id}

id name reason message assistantId phoneNumber extension isActive waitForResponse properties success data createdAt updatedAt metadata timestamp version path error code details field

Update transfer reason

Partially update a transfer reason. Only the fields provided in the request body will be updated. Use this when: - You want to update only specific fields without affecting others - Making quick changes to transfer reason properties - Updating individual fields like phone number or message ⚠️ Only the fields you include in the request will be updated. Other fields will remain unchanged.

Try it in the API Explorer

Example request

Terminal
curl -X PATCH "https://core-api.heysadie.ai/transfer-reasons/TRANSFER_REASON_ID" \
  -H "Authorization: ApiKey YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "reason": "string",
    "message": "string"
  }'

Authentication

Authenticate with an API key in the Authorization header using the ApiKey scheme. See Authentication for how keys work and where to get them.

Authorizationstringrequired

API key in the ApiKey scheme: ApiKey YOUR_API_KEY. Tenant keys authorize their own tenant; organization keys can act on any tenant in the organization.

X-Tenant-Idstring (uuid)optional

Required when authenticating with an organization key: it selects the tenant the request acts on. Omit with tenant keys.

Request

Path parameters

idstringrequired

The resource's UUID.

Body application/json · required

namestringoptional

A friendly name for this transfer reason

reasonstringoptional

Trigger that causes the assistant to transfer the call (e.g., user wants to talk to a human)

messagestringoptional

What the assistant says before transferring the call

assistantIdstring (uuid)optional

The assistant ID this rule applies to

phoneNumberstringoptional

Phone number to forward the call to

extensionstringoptional

Extension to dial automatically once the call connects. Leave blank to keep current behavior.

isActivebooleanoptional

Whether the transfer reason is active

waitForResponsebooleanoptional

Whether the assistant should wait for the caller's response before transferring (default: true)

propertiesanyoptional

Responses

200
successbooleanrequired

true on every 2xx

dataobjectoptional

The result

Show 12 child properties
idstringrequired
namestringrequired
reasonstringrequired
messagestringrequired
assistantIdstringrequired
propertiesanyrequired
phoneNumberstringrequired
extensionstring | nullrequired
isActiveboolean | nullrequired
waitForResponseboolean | nullrequired
createdAtstring (date-time) | string (date) | number | nullrequired
updatedAtstring (date-time) | string (date) | number | nullrequired
metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

400The request is invalid. `details` lists each field that failed
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 3 child properties
codeenumrequired

A parameter or body field broke a rule

Allowed values:"VALIDATION_ERROR"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

detailsobject[]optional

One entry per field that failed

Show 2 item properties
fieldstringrequired

The offending field

messagestringrequired

The rule it broke

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

401Missing or invalid credentials
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 2 child properties
codeenumrequired

No valid credentials

Allowed values:"UNAUTHORIZED"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

403The credentials are valid but may not use this route
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 2 child properties
codeenumrequired

The credentials may not use this route

Allowed values:"FORBIDDEN"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

404Not found, or outside the caller's scope
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 2 child properties
codeenumrequired

An id names nothing the caller can see

Allowed values:"RESOURCE_NOT_FOUND"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested

500An unexpected server error
successbooleanrequired

false on every error

errorobjectoptional

What went wrong: a stable `code` to branch on and a human-readable `message`

Show 2 child properties
codeenumrequired

An unexpected server failure

Allowed values:"INTERNAL_SERVER_ERROR"
messagestringrequired

Human-readable explanation. Do not parse it; branch on `code`

metadataobjectoptional

Request metadata

Show 3 child properties
timestampstringrequired

When the server answered, ISO 8601 UTC

versionstringrequired

API version

pathstringoptional

The URL that was requested