Salutations

List, create, read, update and delete the salutations, such as Dr or Ms, used on contacts.

Salutations are the settings records for forms of address. You can list, create, read, update and delete them. This area has 5 endpoints, and all seven SDKs call every one.

At a glance

Endpoint	Method	Path	What it does
List salutations	GET	/settings/salutations	Returns a page of salutations under data, with paging details under pagination.
Create a salutation	POST	/settings/salutations	Creates a salutation and returns it under salutation.
Retrieve a salutation	GET	/settings/salutations/{salutation_id}	Returns one salutation by its id, under salutation.
Delete a salutation	DELETE	/settings/salutations/{salutation_id}	Deletes a salutation. The response has no body.
Update a salutation	PATCH	/settings/salutations/{salutation_id}	Changes the fields you send on a salutation and returns it under salutation.

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

• Requests and responses wrap the record in salutation. A create sends {"salutation": {...}}.
• A create needs only a name. The new salutation’s display_name takes the same value.
• Listings page by cursor. Records sit under data; pass pagination.next_cursor as cursor to read the next page, and stop when pagination.has_more is false.
• A delete returns 204 with no body. Reading the salutation afterwards returns 404.