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
externalId
Your id for the rep (letters, digits and . _ - : @ | +, up to 200).
Request
This endpoint expects an object.
name
Required when the rep is new.
mobileNumber
voicemailVoice
Response
OK
id
A UUID.
externalId
Your id for the rep.
addedBy
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.
name
mobileNumber
voicemailVoice
online
Their softphone is in its presence room now.
lastSeenAt
createdAt
Errors
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error