Skip to main content
PATCH
Update a company sender application

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.

Path Parameters

id
string<uuid>
required

Company sender ID in the authenticated workspace.

Body

application/json

Replace the complete editable profile and review details; read the current application before changing it.

profile
object
required

Company identity shown on RCS messages. Saving a profile does not grant approval.

details
object
required

Company-owned evidence used for review; complete required details before submission.

countries
enum<string>[]

Requested countries. Germany is currently available; other country fees and approvals must be supported before booking.

Required array length: 1 element
Available options:
DE
assistant_id
string<uuid>

Assistant assigned to the company sender connection.

linked_phone_number_id
string<uuid> | null

Existing workspace number for the default connection. Omit to preserve the current connection. Pass null and omit default_connector_id to clear the fallback. The previous default number switches to SMS only.

default_connector_id
string<uuid> | null

Default SMS connector for new incoming RCS contacts.

expected_updated_at
string<date-time>

Previously read updated_at value; stale edits are rejected.

Response

Update a company sender application.

data
object
required