Contacts

Update custom contact channel

Update a contact channel. Only channels of type 'custom' can be updated. For other channel types, the channel information is managed by the integration and cannot be modified directly.

patch/orgs/contacts/{contact_id}/channels/{channel_id}

Request

  • Base URL: https://api.useinvent.com
  • URL: https://api.useinvent.com/orgs/contacts/{contact_id}/channels/{channel_id}
  • Auth: HTTP bearer

Path parameters

contact_idstring required

Contact ID

channel_idstring required

Channel ID

Request body

avatarstring uri nullable

The avatar for the contact channel, e.g X Avatar URL

namestring nullable

The name for the contact channel, e.g Full Name

phonestring nullable

The phone number for the contact channel, e.g Phone Number

usernamestring nullable

The username for the contact channel, e.g Username

emailstring email nullable

The email for the contact channel, e.g Email

Response

idstring required
type'internal' | 'org' | 'agent' | 'custom' | 'whatsapp_bot' | 'messenger_bot' | 'instagram_dm' | 'tiktok_dm' | 'telegram_bot' | 'slack_bot' | 'teams_bot' | 'gmail' | 'outlook' | 'twilio' | 'telnyx' | 'email' | 'smpp' required

The channel type

user_idstring required

The unique identifier for the contact channel, e.g Phone Number or User ID

avatarstring nullable required

The avatar for the contact channel, e.g X Avatar URL

namestring nullable required

The name for the contact channel, e.g Full Name

usernamestring nullable required

The username for the contact channel, e.g Username

emailstring nullable required

The email for the contact channel, e.g Email

phonestring nullable required

The phone number for the contact channel, e.g Phone Number

countrystring nullable required

The country code associated with the contact channel, e.g US for United States

agentstring nullable required

The user agent associated with the contact channel

ipstring nullable required

The IP address associated with the contact channel

languagestring nullable required

The language code associated with the contact channel, e.g en for English

linkstring

A link to the contact channel, e.g a link to the social media profile

created_atstring date-time required
updated_atstring date-time required

Changes

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