Check if contact name is available
GET/v1/contacts/check_name
Check if a contact name is available. Always returns 200; inspect available in the response
body ({ available: true, count: 0 } when free, { available: false, count: N, suggested_name }
when taken). Without the name parameter, returns the total count for generating suggested
names. Permissions - contacts.read. API keys - manage.
Request
Responses
- 200
- 401
- 500
Contact name availability result or scope count
Unauthorized
Response Headers
X-Request-Id
Unique identifier for the API request, useful for debugging and tracking.
Example:
abc123xyz789Internal Server Error
Response Headers
X-Request-Id
Unique identifier for the API request, useful for debugging and tracking.
Example:
abc123xyz789