Skip to navigation

Create or update a rep

Keyed by your own user id. Fields left out keep their value; name is required for a new rep.

Sessions: admins.

Needs the calls:write scope. A key without it gets 403 insufficient_scope. Routes not in this reference cannot be called with a key at all (403 not_available_to_api_keys).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

externalIdstringRequired

Your id for the rep (letters, digits and . _ - : @ | +, up to 200).

Request

This endpoint expects an object.
namestringOptional<=120 characters
Required when the rep is new.
mobileNumberstring or nullOptional
voicemailVoicestring or nullOptional<=120 characters

Response

OK
idstring
A UUID.
externalIdstring
Your id for the rep.
addedByobject or null

What added the rep: a connected app (app), one of your API keys (api_key) or a person (person), and its name then. Null for reps from before 17 Nov 2026.

namestring
mobileNumberstring or null
voicemailVoicestring or null
onlineboolean
Their softphone is in its presence room now.
lastSeenAtdatetime or null
createdAtdatetime

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error