Skip to main content
PATCH
Update Project

Authorizations

X-API-Key
string
header
required

Authenticate every request by passing your API key in the X-API-Key header. Keys are scoped to your organization hierarchy.

Headers

Idempotency-Key
string

Optional idempotency key: a unique string of 16-200 printable ASCII characters (a UUID is recommended). Retrying the write with the same key within 24 hours returns the stored response of the first call with an X-Idempotent-Replayed: true response header instead of executing it again. Reusing a key with a different request body returns 422 (IDEMPOTENCY_MISMATCH); a duplicate sent while the first call is still running returns 409 with a Retry-After header. Keys are scoped per endpoint and organization.

Required string length: 16 - 200

Path Parameters

id
string
required

Resource ID

Body

application/json
name
string
message_text
string
protocol
enum<string>
Available options:
sms,
mms
phone_number_ids
string[]

Replace the project's sending phone numbers (1-49). New conversations rotate across them; existing conversations keep their already-assigned sticky number.

Required array length: 1 - 49 elements
phone_number_id
string
deprecated

Deprecated. Use phone_number_ids. A single id is treated as a one-element phone_number_ids.

contact_list_ids
string[]
Minimum array length: 1
suppression_list_ids
string[]
media_ids
string[]

Contact field appended as a redirect query param on tracking links ('phone', a custom-field name, or null for none).

Maximum string length: 64

Response

Project updated

success
boolean
required
data
object
required