Skip to content
OnCoreDocs
SMS Reasons

PUThttps://core-api.heysadie.ai/sms-reasons/{id}

id name reason message assistantId content properties success data createdAt updatedAt metadata timestamp version path error code details field

Replace sms reason

Try it in the API Explorer

Example request

Terminal
curl -X PUT "https://core-api.heysadie.ai/sms-reasons/SMS_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 — 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 label for this SMS reason

reasonstringoptional

The event or trigger that causes this SMS to be sent (e.g., user asks for a price list)

messagestringoptional

What the assistant says before sending the SMS (e.g., 'I'll send you the price list via SMS')

assistantIdstring (uuid)optional

The assistant ID this reason is associated with

contentstringoptional

The actual SMS message to be sent to the caller (e.g., a link or info)

propertiesanyoptional

Responses

200
successbooleanrequired
dataobjectoptional
Show 9 child properties
idstringrequired
namestringrequired
reasonstringrequired
messagestringrequired
assistantIdstringrequired
propertiesanyrequired
contentstringrequired
createdAtstring (date-time) | string (date) | number | nullrequired
updatedAtstring (date-time) | string (date) | number | nullrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
400
successbooleanrequired
errorobjectoptional
Show 3 child properties
codeenumrequired
Allowed values:"VALIDATION_ERROR"
messagestringrequired
detailsobject[]optional
Show 2 item properties
fieldstringrequired
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
401
successbooleanrequired
errorobjectoptional
Show 2 child properties
codeenumrequired
Allowed values:"UNAUTHORIZED"
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
403
successbooleanrequired
errorobjectoptional
Show 2 child properties
codeenumrequired
Allowed values:"FORBIDDEN"
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
404
successbooleanrequired
errorobjectoptional
Show 2 child properties
codeenumrequired
Allowed values:"RESOURCE_NOT_FOUND"
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional
500
successbooleanrequired
errorobjectoptional
Show 2 child properties
codeenumrequired
Allowed values:"INTERNAL_SERVER_ERROR"
messagestringrequired
metadataobjectoptional
Show 3 child properties
timestampstringrequired
versionstringrequired
pathstringoptional