get https://yourdomain.webexcampaign.io/campaignapi/resources/v3/profilequerystatus/$(request-id)
This API is used to check the status of asynchronous profile requests if the request was processed before the result file path is returned.
Know your endpoint
Based on the domain you use to log in to Webex Campaign, the endpoint domain for your API varies. For more information, refer to the Know Your API Endpoints section.
Go to the Postman Collection section to learn how to import a Postman collection. Click the below button, If you already know how to import a postman collection.
Request Headers
The following table describes the request headers:
| Request Header | Description |
|---|---|
| content-Type | application/json |
| authorization | Access token or API Secret Key in Bearer format Example: Bearer $(key) |
Body Parameters
This API will return the following response parameters:
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| request-id | String | Yes | Specifies the “request-id”. The id is returned using "GetContactProfile” and “UpdateContactProfile” APIs in async mode. |
Request Example
https://<client domain>/campaignapi/resources/v3/profilequerystatus/12345
Response Parameters
This API will return the following response parameters:
| Parameter | Description |
|---|---|
| file | Returns the success file path. This parameter is returned using “Get Contact Profile” API in Async mode. |
| error-file | Returns the error file path. This parameter is available for the “UpdateContactProfile” API in async mode. The error-file will be part of the response. Below is the error file format: Record separator: New line character (\r\n). Field Separator: , (comma) Headers: Code, Description, and Index. EnclosedBy: Data for the description field will be enclosed by "and will be escaped by . Data: 123 , Failed, 1 123 , Failed, 31 123 , Failed, 40 |
| update-count | Returns the count of updated profiles. This parameter is returned for “Update Contact Profile” API in async mode. |
Failure Response Codes
The API will return code within the response as per the following table in case of failure scenarios.
| HTTP Status Code | Code within API Response | Description |
|---|---|---|
| 200 | 1010 | The request was not processed. |
| 3005 | Invalid Profile ID | |
| 7031 | Profile Id and Profile name do not match. | |
| 401 | 430 | Authorization failed. This resource is not allowed to access using this TOKEN or KEY |
| 498 | Invalid token or Access token expired | |
| 405 | 405 | Method not supported |
| 429 | 429 | Too many requests. Throttle limit reached for the time window. |
| 499 | 499 | Request failed. Check the exact reason of failure in application code and description of error stream. |
| 500 | 500 | Internal server error |
| 1001 | Invalid input JSON |