Purpose
The name API is used to display the name of a contact when their contact ID is provided.
UI Reference: The API is used on pages that need to display a contact's name. It provides the most descriptive name available.
URI: webapp-api-custinfo?api=name
Access Rights Required: All agent types are allowed to use this endpoint.
Request
Request Parameter
Name |
Type |
Description |
|---|---|---|
contactID |
Integer |
This parameter represents the ID of the contact. |
Request Payload Example
{ |
Response
Response Parameters
The response does not contain JSON values.
Response Payload Example
The response generated from this API endpoint is a string that contains the name of the contact, or email address if there is no name. The response is not in JSON format.
If the contact has a name
"John Doe"
If the contact has no name, but has an email address.
"john.doe@example.com" |
