Webex · Example Payload

Webex Bulk Create Or Update Contacts Example

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Webex Bulk Create Or Update Contacts Example is an example object payload from Webex, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "Bulk Create or Update Contacts",
  "method": "POST",
  "path": "/contacts/organizations/{orgId}/contacts/bulk",
  "summary": "Bulk Create or Update Contacts",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "schemas": "urn:cisco:codev:identity:contact:core:1.0",
        "contacts": [
          {
            "contactId": "6847ee0f-5e9c-4403-9f0e-0aa8552f7828",
            "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
              }
            ]
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "contacts": [
          {
            "schemas": "urn:cisco:codev:identity:contact:core:1.0",
            "meta": {
              "created": "2023-05-12T06:53:12.141Z",
              "lastModified": "2023-05-12T06:53:12.142Z"
            },
            "contactId": "5a521987-5407-4824-9389-d4ca82b85752",
            "displayName": "simizhan1",
            "emails": [
              {
                "type": "WORK",
                "value": "simizhan1@example.com"
              }
            ],
            "source": "CH",
            "isMigration": false,
            "orgId": "d23736ac-8055-433e-b85a-0fc55c96ead9"
          },
          null,
          null
        ],
        "failedContacts": [
          {
            "id": "1",
            "errorCode": "external.non.privilege",
            "errorMessage": "Caller is not authorized for source null, only sources [CH] are allowed",
            "statusCode": 403
          },
          {
            "id": "2",
            "errorCode": "external.non.privilege",
            "errorMessage": "Caller is not authorized for source null, only sources [CH] are allowed",
            "statusCode": 403
          }
        ],
        "orgId": "d23736ac-8055-433e-b85a-0fc55c96ead9"
      }
    }
  ]
}