Designations

Manage designations in Exsited: list, create, retrieve, update and delete the job titles you assign.

Designations are the job titles configured in your Exsited settings. You can list, create, retrieve, update and delete them. This area has 5 endpoints, each available in all seven SDKs.

Deleting a designation cannot be undone.

At a glance

Endpoint	Method	Path	What it does
List designations	GET	/settings/designations	Lists the designations (job titles) set up in Exsited, one page at a time.
Create a designation	POST	/settings/designations	Creates a designation and returns it under designation.
Retrieve a designation	GET	/settings/designations/{designation_id}	Retrieves one designation by its des_ id.
Delete a designation	DELETE	/settings/designations/{designation_id}	Deletes a designation; the response has no body.
Update a designation	PATCH	/settings/designations/{designation_id}	Changes a designation’s name, display name or description.

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

• Request bodies go under designation. Both the create and the update wrap their fields in a designation object, and the response returns the record under the same key.
• name is required to create a designation.
• Designation ids start with des_. Pass that id as designation_id.
• The list pages by cursor. Records are under data; pass pagination.next_cursor as cursor while pagination.has_more is true.