Webex · Schema

CreateContactListResponse

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
outcome string Outcome of the operation
statusCode integer 0 for success, non-zero for failure or validation failure
contactListId string Contact List ID within the campaign (number only)
View JSON Schema on GitHub

JSON Schema

webex-createcontactlistresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateContactListResponse",
  "title": "CreateContactListResponse",
  "type": "object",
  "properties": {
    "outcome": {
      "type": "string",
      "enum": [
        "Success",
        "Failure"
      ],
      "description": "Outcome of the operation",
      "example": "Success"
    },
    "statusCode": {
      "type": "integer",
      "description": "0 for success, non-zero for failure or validation failure",
      "example": 0
    },
    "contactListId": {
      "type": "string",
      "description": "Contact List ID within the campaign (number only)",
      "example": "501"
    }
  },
  "example": {
    "success": {
      "summary": "Contact list created successfully",
      "value": {
        "outcome": "Success",
        "statusCode": 0,
        "contactListId": "501"
      }
    },
    "failure": {
      "summary": "Failed to create contact list",
      "value": {
        "outcome": "Failure",
        "statusCode": 400,
        "error": {
          "code": "InvalidRequest",
          "message": "Invalid request parameters"
        }
      }
    }
  }
}