This API returns a list of Profiles and their corresponding attributes. You can also get information on a specific Profile and its attributes by specifying the Profile ID in the API request.
What is profile metadata?
The profile metadata consists of profile name, profile validity, and the attributes of the profile such as attribute name, attribute id, data type, and so on.
When should I fetch profile metadata? And what should I do after fetching it?
You can fetch the profile metadata to know the profile definition without logging into Webex Campaign. The fetched metadata is then used to analyze and modify the data of the data that is being added to the profile from a 3rd party system.
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) |
Request Example
https://yourdomain.webexcampaign.io/campaignapi/metadata/v3/profile/123123123
https://yourdomain.webexcampaign.io/campaignapi/metadata/v3/profile/
Response Parameters
This API will return the following response parameters:
| Parameter | Description |
|---|---|
| profile-id | Returns the profile ID. |
| profile-name | Returns the profile name. |
| attributes | Returns an array of list of the attribute defined under the profile. Each attribute consists below info. |
| datatype | Returns the attribute data type in a JSObject. group-name: Returns the attribute group name. id: Returns the attribute id. name : Returns the attribute name. parent-groupname: Returns the attributes parent group name. * value: Returns the attribute value. |
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. |
| 200 | 1021 | Profile Id does not exist |
| 401 | 430 | Authorization failed. This resource is not allowed to access using this TOKEN or KEY |
| 401 | 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 |