Create a Contact
Creating a new contact for a given organization requires an org admin role.
At least one of the following body parameters: phoneNumbers, emails, sipAddresses is required to create a new contact for source "CH",
displayName is required to create a new contact for source "Webex4Broadworks".
Use the optional groupIds field to add group IDs in an array within the organisation contact. This will become a group contact.
URI Parameters
Webex Identity assigned organization identifier for the user's organization or the organization he manages.
Body Parameters
"urn:cisco:codev:identity:contact:core:1.0".
The full name of the contact.
The first name of the contact.
The last name of the contact.
The company the contact is working for.
The contact's title.
Contact's address.
The URL to the person's avatar in PNG format.
The contact's primary contact method.
Data source.
A list of the user's email addresses with an indicator of the user's primary email address.
The email address.
The type of the email.
A Boolean value indicating the email status.
A list of user's phone numbers with an indicator of primary to specify the user's main number.
The phone number.
The types of the phone numbers.
A Boolean value indicating the phone number's primary status.
The SIP addresses for the user.
The SIP address.
SIP address type.
Designate the primary sipAddress.
Instant messaging addresses for the user.
The IMS account value.
The type of the IMS.
A Boolean value indicating the IMS account status.
Groups associated with the contact.
Response Properties
"urn:cisco:codev:identity:contact:core:1.0".
Response metadata.
The date and time the contact was created.
The date and time the contact was last changed.
The full name of the contact.
The first name of the contact.
The last name of the contact.
The company the contact is working for.
The contact's title.
Contact's address.
The URL to the person's avatar in PNG format.
The contact's primary contact method.
Where the data come from.
A list of the user's email addresses with an indicator of the user's primary email address.
The email address.
The type of the email.
A Boolean value indicating the email status.
A list of user's phone numbers with an indicator of primary to specify the user's main number.
The phone number.
The types of the phone numbers.
A Boolean value indicating the phone number's primary status.
The sipAddress values for the user.
The sipAddress value.
The type of the sipAddress.
Designate the primary sipAddress.
Instant messaging addresses for the user.
The IMS account value.
The type of the IMS.
A Boolean value indicating the IMS account status.
Groups associated with the contact.
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Body
- "urn:cisco:codev:identity:contact:core:1.0".
- The full name of the contact.
- The first name of the contact.
- The last name of the contact.
- The company the contact is working for.
- The contact's title.
- Contact's address.
- The URL to the person's avatar in PNG format.
- The contact's primary contact method.
- Data source.
- A list of the user's email addresses with an indicator of the user's primary email address.
- A list of user's phone numbers with an indicator of primary to specify the user's main number.
- The SIP addresses for the user.
- Instant messaging addresses for the user.
- Groups associated with the contact.
{
"schemas": "urn:cisco:codev:identity:contact:core:1.0",
"displayName": "John Andersen",
"firstName": "John",
"lastName": "Andersen",
"companyName": "Cisco Systems",
"title": "GM",
"address": "{\\\"city\\\" : \\\"Milpitas\\\", \\\"country\\\" : \\\"US\\\", \\\"street\\\" : \\\"1099 Bird Ave.\\\", \\\"zipCode\\\" : \\\"99212\\\"}",
"avatarURL": "https://avatar-prod-us-east-2.webexcontent.com/default_avatar~1600",
"primaryContactMethod": "SIPADDRESS",
"source": "Webex4Broadworks",
"emails": [
{
"value": "user1@example.home.com",
"type": "home",
"primary": false
}
],
"phoneNumbers": [
{
"value": "400 123 1234",
"type": "work",
"primary": true
}
],
"sipAddresses": [
{
"value": "sipAddress value1",
"type": "enterprise",
"primary": true
}
],
"ims": [
{
"value": "aim_account_ID",
"type": "aim",
"primary": true
}
],
"groupIds": [
"9ac175bf-0249-4287-8fb3-e320e525fcf6"
]
}{
"schemas": "urn:cisco:codev:identity:contact:core:1.0",
"meta": {
"created": "2023-05-10T09:24:44.910Z",
"lastModified": "2023-05-10T09:24:44.910Z"
},
"contactId": "933de120-ad46-49b0-91cc-65c3966bb14e",
"firstName": "Simic",
"lastName": "Zhang",
"companyName": "Cisco Systems",
"title": "Product Manager",
"address": "{\"city\" : \"Milpitas\", \"country\" : \"US\", \"street\" : \"1099 Bird Ave.\", \"zipCode\" : \"99212\"}",
"avatarURL": "https://avatar-prod-us-east-2.webexcontent.com/default_avatar~1600",
"displayName": "Logan",
"addressInfo": {
"city": "Milpitas",
"country": "US",
"street": "1099 Bird Ave.",
"zipCode": "99212"
},
"primaryContactMethod": "EMAIL",
"phoneNumbers": [
{
"type": "work",
"value": "20134319"
}
],
"emails": [
{
"type": "work",
"value": "simizhan@example.com"
}
],
"sipAddresses": [
{
"type": "work",
"value": "sip://mysip1231233"
}
],
"ims": [
{
"type": "work",
"value": "87003922"
}
],
"source": "CH",
"isMigration": false,
"orgId": "153ced48-d2d1-4369-86fd-9b9fade218ff",
"groupIds": [
"b3e594aa-19ea-488a-9d42-f811e272f4bd"
]
}