POST | /api/clients/{clientId}/caller |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ClientId | path | string | Yes | The unique ID of this client |
CallerId | body | string | Yes | The caller ID for this Caller record |
Notes | body | string | No | The notes to associate with the caller record |
DefaultActivity | body | string | No | An optional activity to add to the caller's record |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CustomerName | form | string | Yes | The HostedSuite Customer Name |
UserName | form | string | Yes | The HostedSuite User Name. Data visibility and security is based on this user's permissions. |
Password | form | string | Yes | The HostedSuite User's Password |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/clients/{clientId}/caller HTTP/1.1
Host: evo.hostedsuite.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ClientId: String,
CallerId: String,
Notes: String,
DefaultActivity: String,
CustomerName: String,
UserName: String,
Password: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { }