openapi: 3.0.0 info: title: Webex Admin Address Book Organization Contacts API version: 1.0.0 description: The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling. tags: - name: Organization Contacts paths: /contacts/organizations/{orgId}/contacts: post: responses: '201': description: Created headers: {} content: application/json: schema: $ref: '#/components/schemas/ContactResponse' example: 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 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Create a Contact operationId: Create a Contact description: '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.' tags: - Organization Contacts parameters: - name: orgId in: path description: Webex Identity assigned organization identifier for the user's organization or the organization he manages. required: true example: 0ae87ade-8c8a-4952-af08-318798958d0c schema: type: string requestBody: content: application/json: example: 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 schema: $ref: '#/components/schemas/Contact' /contacts/organizations/{orgId}/contacts/{contactId}: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/ContactResponse' example: schemas: urn:cisco:codev:identity:contact:core:1.0 meta: created: '2023-05-11T02:55:25.460Z' lastModified: '2023-05-11T02:55:25.460Z' contactId: 6847ee0f-5e9c-4403-9f0e-0aa8552f7829 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: d23736ac-8055-433e-b85a-0fc55c96ead9 groupIds: - b3e594aa-19ea-488a-9d42-f811e272f4bd '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Get a Contact operationId: Get a Contact description: 'Shows details for an organization contact by ID. Specify the organization ID in the `orgId` parameter in the URI, and specify the contact ID in the `contactId` parameter in the URI. **NOTE**: The `orgId` used in the path for this API are the org UUIDs. They follow a xxxx-xxxx-xxxx-xxxx pattern. If you have an orgId in base64 encoded format (starting with Y2.....) you need to base64 decode the id and extract the UUID from the slug, before you use it in your API call.' tags: - Organization Contacts parameters: - name: orgId in: path description: Webex Identity assigned organization identifier for the user's organization or the organization he manages. required: true example: d23736ac-8055-433e-b85a-0fc55c96ead8 schema: type: string - name: contactId in: path description: The contact ID. required: true example: 6847ee0f-5e9c-4403-9f0e-0aa8552f7828 schema: type: string patch: responses: '200': description: OK headers: {} content: application/json: schema: type: object properties: schemas: type: string meta: type: object properties: created: type: string lastModified: type: string contactId: type: string firstName: type: string lastName: type: string companyName: type: string title: type: string address: type: string avatarURL: type: string displayName: type: string addressInfo: type: object properties: city: type: string country: type: string street: type: string zipCode: type: string primaryContactMethod: type: string phoneNumbers: type: array items: type: object properties: type: type: string value: type: string emails: type: array items: type: object properties: type: type: string value: type: string sipAddresses: type: array items: type: object properties: type: type: string value: type: string ims: type: array items: type: object properties: type: type: string value: type: string source: type: string isMigration: type: boolean orgId: type: string groupIds: type: array items: type: string example: schemas: urn:cisco:codev:identity:contact:core:1.0 meta: created: '2023-05-11T02:55:25.460Z' lastModified: '2023-05-11T02:55:25.460Z' contactId: 6847ee0f-5e9c-4403-9f0e-0aa8552f7829 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: d23736ac-8055-433e-b85a-0fc55c96ead9 groupIds: - b3e594aa-19ea-488a-9d42-f811e272f4bd '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Update a Contact operationId: Update a Contact description: 'Update details for contact by ID. Only an admin can update a contact. Specify the organization ID in the `orgId` parameter in the URI, and specify the contact ID in the `contactId` parameter in the URI. Use the optional `groupIds` field to update the group IDs by changing the existing array. You can add or remove one or all groups. To remove all associated groups, pass an empty array in the `groupIds` field.' tags: - Organization Contacts parameters: - name: orgId in: path description: Webex Identity assigned organization identifier for the user's organization or the organization he manages. required: true example: d23736ac-8055-433e-b85a-0fc55c96ead8 schema: type: string - name: contactId in: path description: The contact ID. required: true example: 6847ee0f-5e9c-4403-9f0e-0aa8552f7828 schema: type: string requestBody: content: application/json: example: 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 operation: delete sipAddresses: - value: sipAddress value1 type: enterprise primary: true ims: - value: aim_account_ID type: aim primary: true groupIds: - 9ac175bf-0249-4287-8fb3-e320e525fcf6 schema: $ref: '#/components/schemas/UpdateContact' delete: responses: '204': description: No Content headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Delete a Contact operationId: Delete a Contact description: 'Remove a contact from the organization. Only an admin can remove a contact. Specify the organization ID in the `orgId` parameter in the URI, and specify the contact ID in the `contactId` parameter in the URI.' tags: - Organization Contacts parameters: - name: orgId in: path description: Webex Identity assigned organization identifier for the user's organization or the organization he manages. required: true example: d23736ac-8055-433e-b85a-0fc55c96ead8 schema: type: string - name: contactId in: path description: The contact ID. required: true example: 6847ee0f-5e9c-4403-9f0e-0aa8552f7828 schema: type: string /contacts/organizations/{orgId}/contacts/search: get: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/SearchResponse' example: result: - schemas: urn:cisco:codev:identity:contact:core:1.0 meta: created: '2023-05-11T01:59:38.398Z' lastModified: '2023-05-11T01:59:38.398Z' contactId: 441d0fa5-7fa0-491e-b27a-f017896c0bab 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: d23736ac-8055-433e-b85a-0fc55c96ead9 groupIds: - b3e594aa-19ea-488a-9d42-f811e272f4bd start: 0 limit: 1000 total: 1 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: List Contacts operationId: List Contacts description: 'List contacts in the organization. The default limit is `100`. `keyword` can be the value of "displayName", "firstName", "lastName", "email". An empty string of `keyword` means get all contacts. `groupIds` is a comma separated list group IDs. Results are filtered based on those group IDs. Long result sets will be split into [pages](/docs/basics#pagination).' tags: - Organization Contacts parameters: - name: orgId in: path description: The organization ID. required: true example: d23736ac-8055-433e-b85a-0fc55c96ead8 schema: type: string - name: keyword in: query description: List contacts with a keyword. example: john.andersen@example.com schema: type: string - name: source in: query description: List contacts with source. example: CH schema: type: string - name: limit in: query description: "Limit the maximum number of contact in the response.\n + Default: 100\n" example: '100' schema: type: number - name: groupIds in: query description: Filter contacts based on groups. example: 9ac175bf-0249-4287-8fb3-e320e525fcf6,23b95024-7063-404c-9a3c-37532f53a9ce schema: type: array items: type: string example: 9ac175bf-0249-4287-8fb3-e320e525fcf6,23b95024-7063-404c-9a3c-37532f53a9ce description: Filter contacts based on groups. /contacts/organizations/{orgId}/contacts/bulk: post: responses: '200': description: OK headers: {} content: application/json: schema: $ref: '#/components/schemas/BulkCreateResponse' 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 '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Bulk Create or Update Contacts operationId: Bulk Create or Update Contacts description: Create or update contacts in bulk. Update an existing contact by specifying the contact ID in the `contactId` parameter in the request body. tags: - Organization Contacts parameters: - name: orgId in: path description: Webex Identity assigned organization identifier for the user's organization or the organization he manages. required: true example: 0ae87ade-8c8a-4952-af08-318798958d0c schema: type: string requestBody: content: 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 schema: $ref: '#/components/schemas/BulkCreate' /contacts/organizations/{orgId}/contacts/bulk/delete: post: responses: '200': description: OK headers: {} content: {} '400': description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.' '401': description: 'Unauthorized: Authentication credentials were missing or incorrect.' '403': description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.' '404': description: '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': description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.' '409': description: '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': description: 'Gone: The requested resource is no longer available.' '415': description: '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': description: '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': description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.' '429': description: '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': description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).' '502': description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.' '503': description: 'Service Unavailable: Server is overloaded with requests. Try again later.' '504': description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.' summary: Bulk Delete Contacts operationId: Bulk Delete Contacts description: Delete contacts in bulk. tags: - Organization Contacts parameters: - name: orgId in: path description: Webex Identity assigned organization identifier for the user's organization or the organization he manages. required: true example: 0ae87ade-8c8a-4952-af08-318798958d0c schema: type: string requestBody: content: application/json: example: schemas: urn:cisco:codev:identity:contact:core:1.0 objectIds: - 8a5fac49-2c5f-4773-aec7-02db0e3a9d72 schema: $ref: '#/components/schemas/BulkDelete' components: schemas: SearchResponse: type: object properties: result: type: array items: $ref: '#/components/schemas/ContactResponse' description: An array of contact objects. start: type: number description: Start at the zero-based offset in the list of matching contacts. limit: type: number example: 1000 description: Limit the number of contacts returned to this maximum count. total: type: number example: 1 description: Total number of contacts returned in search results. BulkDelete: type: object required: - schemas - objectIds properties: schemas: type: string example: urn:cisco:codev:identity:contact:core:1.0 description: '"urn:cisco:codev:identity:contact:core:1.0".' objectIds: type: array items: type: string example: 8a5fac49-2c5f-4773-aec7-02db0e3a9d72 description: List of UUIDs for the contacts. Meta: type: object properties: created: type: string example: '2022-04-29T13:06:26.831Z' description: The date and time the contact was created. lastModified: type: string example: '2022-05-29T13:06:26.831Z' description: The date and time the contact was last changed. BulkCreate: type: object required: - schemas - contacts properties: schemas: type: string example: urn:cisco:codev:identity:contact:core:1.0 description: '"urn:cisco:codev:identity:contact:core:1.0".' contacts: type: array items: type: object required: - source properties: contactId: type: string example: 6847ee0f-5e9c-4403-9f0e-0aa8552f7828 description: Use this to update an existing contact. displayName: type: string example: John Andersen description: The full name of the contact. firstName: type: string example: John description: The first name of the contact. lastName: type: string example: Andersen description: The last name of the contact. companyName: type: string example: Cisco Systems description: The company the contact is working for. title: type: string example: GM description: The contact's title. address: type: string example: '{\"city\" : \"Milpitas\", \"country\" : \"US\", \"street\" : \"1099 Bird Ave.\", \"zipCode\" : \"99212\"}' description: Contact's address. avatarURL: type: string example: https://avatar-prod-us-east-2.webexcontent.com/default_avatar~1600 description: The URL to the person's avatar in PNG format. primaryContactMethod: type: string enum: - SIPADDRESS - EMAIL - PHONE - IMS description: The contact's primary contact method. source: type: string enum: - CH - Webex4Broadworks description: Where the data come from. emails: type: array items: type: object properties: value: type: string example: user1@example.home.com description: The email address. type: type: string enum: - work - home - room - other description: The type of the email. primary: type: boolean description: A Boolean value indicating the email status. description: A list of the user's email addresses with an indicator of the user's primary email address. phoneNumbers: type: array items: type: object properties: value: type: string example: 400 123 1234 description: The phone number. type: type: string enum: - work - home - mobile - work_extension - fax - pager - other description: The types of phone numbers. primary: type: boolean example: true description: A Boolean value indicating the phone number's primary status. description: A list of user's phone numbers with an indicator of primary to specify the user's main number. sipAddresses: type: array items: type: object required: - value properties: value: type: string example: sipAddress value1 description: The sipAddress value. type: type: string enum: - enterprise - cloud-calling - personal-room description: The type of the sipAddress. primary: type: boolean example: true description: Designate the primary sipAddress. description: The sipAddress values for the user. ims: type: array items: type: object properties: value: type: string example: aim_account_ID description: The IMS account value. type: type: string enum: - aim - cucm-jid - gtalk - icq - msn - qq - skype - webex-messenger-jid - webex-squared-jid - xmpp - yahoo - microsoft-sip-uri - xmpp-fed-jid description: The type of the IMS. primary: type: boolean example: true description: A Boolean value indicating the IMS account status. description: Instant messaging addresses for the user. description: Contains a list of contacts to be created/updated. Contact: type: object required: - schemas - source properties: schemas: type: string example: urn:cisco:codev:identity:contact:core:1.0 description: '"urn:cisco:codev:identity:contact:core:1.0".' displayName: type: string example: John Andersen description: The full name of the contact. firstName: type: string example: John description: The first name of the contact. lastName: type: string example: Andersen description: The last name of the contact. companyName: type: string example: Cisco Systems description: The company the contact is working for. title: type: string example: GM description: The contact's title. address: type: string example: '{\"city\" : \"Milpitas\", \"country\" : \"US\", \"street\" : \"1099 Bird Ave.\", \"zipCode\" : \"99212\"}' description: Contact's address. avatarURL: type: string example: https://avatar-prod-us-east-2.webexcontent.com/default_avatar~1600 description: The URL to the person's avatar in PNG format. primaryContactMethod: type: string enum: - SIPADDRESS - EMAIL - PHONE - IMS description: The contact's primary contact method. source: type: string enum: - CH - Webex4Broadworks description: Data source. emails: type: array items: type: object properties: value: type: string example: user1@example.home.com description: The email address. type: type: string enum: - work - home - room - other description: The type of the email. primary: type: boolean description: A Boolean value indicating the email status. description: A list of the user's email addresses with an indicator of the user's primary email address. phoneNumbers: type: array items: type: object properties: value: type: string example: 400 123 1234 description: The phone number. type: type: string enum: - work - home - mobile - work_extension - fax - pager - other description: The types of the phone numbers. primary: type: boolean example: true description: A Boolean value indicating the phone number's primary status. description: A list of user's phone numbers with an indicator of primary to specify the user's main number. sipAddresses: type: array items: type: object required: - value properties: value: type: string example: sipAddress value1 description: The SIP address. type: type: string enum: - enterprise - cloud-calling - personal-room description: SIP address type. primary: type: boolean example: true description: Designate the primary sipAddress. description: The SIP addresses for the user. ims: type: array items: type: object properties: value: type: string example: aim_account_ID description: The IMS account value. type: type: string enum: - aim - cucm-jid - gtalk - icq - msn - qq - skype - webex-messenger-jid - webex-squared-jid - xmpp - yahoo - microsoft-sip-uri - xmpp-fed-jid description: The type of the IMS. primary: type: boolean example: true description: A Boolean value indicating the IMS account status. description: Instant messaging addresses for the user. groupIds: type: array items: type: string example: 9ac175bf-0249-4287-8fb3-e320e525fcf6 description: Groups associated with the contact. 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. ContactResponse: type: object required: - schemas - meta - source properties: schemas: type: string example: urn:cisco:codev:identity:contact:core:1.0 description: '"urn:cisco:codev:identity:contact:core:1.0".' meta: $ref: '#/components/schemas/Meta' description: Response metadata. contactId: type: string example: 6847ee0f-5e9c-4403-9f0e-0aa8552f7828 description: The unique identifier for the contact. displayName: type: string example: John Andersen description: The full name of the contact. firstName: type: string example: John description: The first name of the contact. lastName: type: string example: Andersen description: The last name of the contact. companyName: type: string example: Cisco Systems description: The company the contact is working for. title: type: string example: GM description: The contact's title. address: type: string example: '{\"city\" : \"Milpitas\", \"country\" : \"US\", \"street\" : \"1099 Bird Ave.\", \"zipCode\" : \"99212\"}' description: Contact's address. avatarURL: type: string example: https://avatar-prod-us-east-2.webexcontent.com/default_avatar~1600 description: The URL to the person's avatar in PNG format. addressInfo: type: object properties: city: type: string description: The city. country: type: string description: The country. street: type: string description: The street address. zipCode: type: string description: The ZIP code. description: Structured address information. primaryContactMethod: type: string enum: - SIPADDRESS - EMAIL - PHONE - IMS description: The contact's primary contact method. source: type: string enum: - CH - Webex4Broadworks description: Where the data come from. emails: type: array items: type: object properties: value: type: string example: user1@example.home.com description: The email address. type: type: string enum: - work - home - room - other description: The type of the email. primary: type: boolean description: A Boolean value indicating the email status. description: A list of the user's email addresses with an indicator of the user's primary email address. phoneNumbers: type: array items: type: object properties: value: type: string example: 400 123 1234 description: The phone number. type: type: string enum: - work - home - mobile - work_extension - fax - pager - other description: The types of the phone numbers. primary: type: boolean example: true description: A Boolean value indicating the phone number's primary status. description: A list of user's phone numbers with an indicator of primary to specify the user's main number. sipAddresses: type: array items: type: object required: - value properties: value: type: string example: sipAddress value1 description: The sipAddress value. type: type: string enum: - enterprise - cloud-calling - personal-room description: The type of the sipAddress. primary: type: boolean example: true description: Designate the primary sipAddress. description: The sipAddress values for the user. ims: type: array items: type: object properties: value: type: string example: aim_account_ID description: The IMS account value. type: type: string enum: - aim - cucm-jid - gtalk - icq - msn - qq - skype - webex-messenger-jid - webex-squared-jid - xmpp - yahoo - microsoft-sip-uri - xmpp-fed-jid description: The type of the IMS. primary: type: boolean example: true description: A Boolean value indicating the IMS account status. description: Instant messaging addresses for the user. isMigration: type: boolean description: Indicates if this contact is part of a migration. orgId: type: string example: d23736ac-8055-433e-b85a-0fc55c96ead9 description: The organization ID that the contact belongs to. groupIds: type: array items: type: string example: 9ac175bf-0249-4287-8fb3-e320e525fcf6 description: Groups associated with the contact. UpdateContact: type: object required: - schemas - source properties: schemas: type: string example: urn:cisco:codev:identity:contact:core:1.0 description: '"urn:cisco:codev:identity:contact:core:1.0".' displayName: type: string example: John Andersen description: The full name of the contact. firstName: type: string example: John description: The first name of the contact. lastName: type: string example: Andersen description: The last name of the contact. companyName: type: string example: Cisco Systems description: The company the contact is working for. title: type: string example: GM description: The contact's title. address: type: string example: '{\"city\" : \"Milpitas\", \"country\" : \"US\", \"street\" : \"1099 Bird Ave.\", \"zipCode\" : \"99212\"}' description: Contact's address. avatarURL: type: string example: https://avatar-prod-us-east-2.webexcontent.com/default_avatar~1600 description: The URL to the person's avatar in PNG format. primaryContactMethod: type: string enum: - SIPADDRESS - EMAIL - PHONE - IMS description: The contact's primary contact method. source: type: string enum: - CH - Webex4Broadworks description: Where the data come from. emails: type: array items: type: object properties: value: type: string example: user1@example.home.com description: The email address. type: type: string enum: - work - home - room - other description: The type of the email. primary: type: boolean description: A Boolean value indicating the email status. description: A list of the user's email addresses with an indicator of the user's primary email address. phoneNumbers: type: array items: type: object properties: value: type: string example: 400 123 1234 description: The phone number. type: type: string enum: - work - home - mobile - work_extension - fax - pager - other description: The types of the phone numbers. primary: type: boolean example: true description: A Boolean value indicating the phone number's primary status. operation: type: string example: delete description: '- A String value on the operation, only `delete` is supported now.' description: A list of user's phone numbers with an indicator of primary to specify the user's main number. sipAddresses: type: array items: type: object required: - value properties: value: type: string example: sipAddress value1 description: The sipAddress value. type: type: string enum: - enterprise - cloud-calling - personal-room description: The type of the sipAddress. primary: type: boolean example: true description: Designate the primary sipAddress. description: The sipAddress values for the user. ims: type: array items: type: object properties: value: type: string example: aim_account_ID description: The IMS account value. type: type: string enum: - aim - cucm-jid - gtalk - icq - msn - qq - skype - webex-messenger-jid - webex-squared-jid - xmpp - yahoo - microsoft-sip-uri - xmpp-fed-jid description: The type of the IMS. primary: type: boolean example: true description: A Boolean value indicating the IMS account status. description: Instant messaging addresses for the user. groupIds: type: array items: type: string example: 9ac175bf-0249-4287-8fb3-e320e525fcf6 description: Groups associated with the contact. securitySchemes: oauth2: flows: authorizationCode: authorizationUrl: / scopes: {} tokenUrl: / type: oauth2 bearer-key: type: http description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN scheme: bearer bearerFormat: JWT bearerAuth: type: oauth2 description: OAuth 2.0 Bearer token authentication flows: authorizationCode: authorizationUrl: https://webexapis.com/v1/authorize tokenUrl: https://webexapis.com/v1/access_token scopes: spark:applications_token: Create access tokens for Service Apps