Communication profiles

List, create, read, update and delete the communication profiles that hold your account messages.

A communication profile holds a set of messages and channel settings that accounts use. Here you list, create, read, update and delete profiles. This area has 5 endpoints, and every SDK supports all of them.

At a glance

Endpoint	Method	Path	What it does
List communication profiles	GET	/settings/communication_profiles	Lists your communication profiles, a page at a time.
Create a communication profile	POST	/settings/communication_profiles	Creates a communication profile and returns it under communication_profile.
Retrieve a communication profile	GET	/settings/communication_profiles/{communication_profile_id}	Returns one communication profile, under communication_profile.
Update a communication profile	PATCH	/settings/communication_profiles/{communication_profile_id}	Changes a communication profile’s fields and channel settings.
Delete a communication profile	DELETE	/settings/communication_profiles/{communication_profile_id}	Deletes a communication profile that is not the default.

Before you call

Register your API credentials once when your app starts, as shown in Authentication. Every SDK sample on these pages then gets its client in one line. With cURL, send the access token in an Authorization header: Authorization: Bearer $ACCESS_TOKEN.

Things to know

• Each profile’s id starts with cmp_. List communication profiles returns each profile’s id.
• name is required to create a profile. Its messages are copied from the profile in copy_from, or from the default profile.
• One profile comes back under communication_profile; a listing comes back under data. A listing also carries pagination; pass pagination.next_cursor as cursor while has_more is true.
• The default profile cannot be deleted. A delete marks the profile deleted, and reading it then returns 404.