Webex · Schema

BulkCreateResponse

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
contacts array Array of contact successfully created.
failedContacts array Array of contacts that failed creation.
orgId string Organization ID in which the contacts were created.
View JSON Schema on GitHub

JSON Schema

webex-bulkcreateresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BulkCreateResponse",
  "title": "BulkCreateResponse",
  "type": "object",
  "properties": {
    "contacts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ContactResponse"
      },
      "description": "Array of contact successfully created."
    },
    "failedContacts": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "2",
            "description": "Bulk ID of the contact object that failed creation."
          },
          "errorCode": {
            "type": "number",
            "example": 403,
            "description": "HTTP Response code for the contact creation failure."
          },
          "errorMessage": {
            "type": "string",
            "example": "Source null is not supported by organization, only sources [CH] are allowed",
            "description": "Error message for the contact creation failure."
          }
        }
      },
      "description": "Array of contacts that failed creation."
    },
    "orgId": {
      "type": "string",
      "example": "36818b6f-ef07-43d1-b76f-ced79ab2e3e7",
      "description": "Organization ID in which the contacts were created."
    }
  }
}