(Created target blank page For Version: HTCC:8.5.2) |
(Update with the copy of version: 8.5.2DRAFT) |
||
Line 1: | Line 1: | ||
− | + | =Update a custom contact= | |
+ | __NOTOC__ | ||
+ | This operation is part of the [[ContactsAPI|Contacts API]] section of the [[Welcome|Web Services API]]. | ||
+ | ==Overview== | ||
+ | Updates a custom contact in the Genesys system. | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! scope="row"| Request URL | ||
+ | | /api/v2/contacts/''{id}'' | ||
+ | |- | ||
+ | ! scope="row"| HTTP Method | ||
+ | | PUT | ||
+ | |- | ||
+ | ! scope="row" | Required Features | ||
+ | | | ||
+ | |} | ||
+ | |||
+ | ==Parameters== | ||
+ | {| | ||
+ | ! Parameter | ||
+ | ! Description | ||
+ | |- | ||
+ | | name | ||
+ | | The name of the contact. | ||
+ | |- | ||
+ | | phoneNumber | ||
+ | | The phone number at which this contact get be reached. | ||
+ | |} | ||
+ | |||
+ | |||
+ | ==Example== | ||
+ | ====Request==== | ||
+ | <source lang="text"> | ||
+ | PUT /api/v2/contacts/c7d9109c-9942-4853-a5e8-0435b03024a4 | ||
+ | { | ||
+ | "name":"My Edited Custom Contact", | ||
+ | "phoneNumber":"111-456-7899" | ||
+ | } | ||
+ | </source> | ||
+ | |||
+ | ====HTTP Response==== | ||
+ | <source lang="text"> | ||
+ | { | ||
+ | "statusCode":0 | ||
+ | } | ||
+ | </source> | ||
+ | |||
+ | |||
+ | |||
+ | [[Category:V:HTCC:8.5.2]] |
Revision as of 18:23, March 25, 2016
Update a custom contact
This operation is part of the Contacts API section of the Web Services API.
Overview
Updates a custom contact in the Genesys system.
Request URL | /api/v2/contacts/{id} |
---|---|
HTTP Method | PUT |
Required Features |
Parameters
Parameter | Description |
---|---|
name | The name of the contact. |
phoneNumber | The phone number at which this contact get be reached. |
Example
Request
PUT /api/v2/contacts/c7d9109c-9942-4853-a5e8-0435b03024a4
{
"name":"My Edited Custom Contact",
"phoneNumber":"111-456-7899"
}
HTTP Response
{
"statusCode":0
}
Comments or questions about this documentation? Contact us for support!