UPupsmith
admin
channels

Create Channel

post/admin/channels/

Request

  • Base URL
    https://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Headers

organization-idstring nullable
timezonestring
x-user-idstring nullable
x-actor-emailstring nullable
x-request-sourcestring nullable
x-operation-idstring nullable
x-commit-messagestring nullable
x-confirmation-idstring nullable
x-chat-idstring nullable

Request body

organization_idstring required
channel_type'sms' | 'sendblue' | 'sms_telnyx' | 'voice' | 'slack' | 'meta_messenger' | 'google_lsa' | 'instagram' | 'yelp' | 'thumbtack' | 'simulation' required
phone_numberstring nullable

Provisioned sending phone number in E.164 format, e.g. +14155551234. Not required for google_lsa channels (their identity is the org's LSA account).

reference_idstring nullable

Provider reference. For Twilio this is the subaccount SID; Telnyx ignores it.

messaging_phone_number_idstring nullable

Persisted eligible registered number to bind to a Twilio or Telnyx SMS channel.

titlestring nullable

Optional operator-facing label for the channel.

Response

Successful Response

idstring required
organization_idstring required
reference_idstring nullable
created_atstring date-time nullable
updated_atstring date-time nullable
deleted_atstring date-time nullable
module_idstring required
titlestring nullable
phone_numberstring nullable
transfer_to_numberstring nullable
voice_idstring nullable
slack_team_idstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.