API endpoint: platform.adobe.io/data/core/activation/authoring/audience-templates
This page exemplifies the API request and payload that you can use to update an audience template, using the /authoring/audience-templates
API endpoint.
For a detailed description of the capabilities that you can configure through this endpoint, see audience metadata management.
All parameter names and values supported by Destination SDK are case sensitive. To avoid case sensitivity errors, please use the parameters names and values exactly as shown in the documentation.
Before continuing, please review the getting started guide for important information that you need to know in order to successfully make calls to the API, including how to obtain the required destination authoring permission and required headers.
You can update an existing audience template by making a PUT
request to the /authoring/audience-templates
endpoint with the updated payload.
To obtain an existing audience template and its corresponding {INSTANCE_ID}
, see the article about retrieving an audience template.
API format
PUT /authoring/audience-templates/{INSTANCE_ID}
Parameter | Description |
---|---|
{INSTANCE_ID} |
The ID of the audience template that you want to update. To obtain an existing audience template and its corresponding {INSTANCE_ID} , see Retrieve a audience template. |
The following request updates an existing audience metadata template, configured by the parameters provided in the payload.
curl -X POST https://platform.adobe.io/data/core/activation/authoring/audience-templates/{INSTANCE_ID} \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"metadataTemplate": {
"name": "Test Webhook Audience Template",
"create": {
"url": "https://your-webhook-site/0bd222fa-8ae2-433b-8f0e-f2ce137b0ee4/{{customerData.customerID}}/segments",
"httpMethod": "POST",
"headers": [
{
"value": "application/json",
"header": "Content-Type"
},
{
"value": "Bearer {{authData.token}}",
"header": "Authorization"
}
],
"requestBody": {
"json": {
"name": "{{segment.name}}",
"type": "segment",
"metadata": {
"org_id": "{{destination.imsOrgId}}",
"sandbox": "{{destination.sandboxName}}",
"destination_id": "{{destination.id}}",
"destination_name": "{{destination.name}}",
"segmentEnrichmentAttributes": "{% set columns = [] %}{% for atr in segmentEnrichmentAttributes %}{% set columns = columns|merge([atr.source]) %}{% endfor %}{{ columns | toJson }}"
},
"external_id": "{{segment.id}}"
}
},
"responseFields": [
{
"value": "{{headers.X-Request-Id}}",
"name": "externalAudienceId"
}
],
"responseErrorFields": [
{
"value": "{{root}}",
"name": "message"
}
]
},
"update": {
"url": "https://your-webhook-site/0bd222fa-8ae2-433b-8f0e-f2ce137b0ee4/{{customerData.customerID}}/segments/{{segment.alias}}",
"httpMethod": "PUT",
"headers": [
{
"value": "application/json",
"header": "Content-Type"
},
{
"value": "Bearer {{authData.token}}",
"header": "Authorization"
}
],
"requestBody": {
"json": {
"name": "{{segment.name}}",
"type": "segment",
"metadata": {
"org_id": "{{destination.imsOrgId}}",
"sandbox": "{{destination.sandboxName}}",
"destination_id": "{{destination.id}}",
"destination_name": "{{destination.name}}",
"segmentEnrichmentAttributes": "{% set columns = [] %}{% for atr in segmentEnrichmentAttributes %}{% set columns = columns|merge([atr.source]) %}{% endfor %}{{ columns | toJson }}"
},
"external_id": "{{segment.id}}"
}
},
"responseFields": [
{
"value": "{{headers.X-Request-Id}}",
"name": "externalAudienceId"
}
],
"responseErrorFields": [
{
"value": "{{root}}",
"name": "message"
}
]
},
"delete": {
"url": "https://your-webhook-site/0bd222fa-8ae2-433b-8f0e-f2ce137b0ee4/{{customerData.customerID}}/segments/{{segment.alias}}",
"httpMethod": "DELETE",
"headers": [
{
"value": "Bearer {{authData.token}}",
"header": "Authorization"
}
],
"responseErrorFields": [
{
"value": "{{root}}",
"name": "message"
}
]
},
"createDestination": {
"url": "https://your-webhook-site/0bd222fa-8ae2-433b-8f0e-f2ce137b0ee4/{{customerData.customerID}}/createDestination",
"httpMethod": "POST",
"headers": [
{
"value": "application/json",
"header": "Content-Type"
},
{
"value": "Bearer {{authData.token}}",
"header": "Authorization"
}
],
"requestBody": {
"json": {
"name": "{{destination.name}}",
"type": "destination",
"metadata": {
"org_id": "{{destination.imsOrgId}}",
"sandbox": "{{destination.sandboxName}}",
"destination_id": "{{destination.id}}",
"destination_name": "{{destination.name}}",
"enrichmentAttributes": "{{destination.enrichmentAttributes}}"
},
"external_id": "{{destination.id}}"
}
},
"responseFields": [
{
"value": "{{headers.X-Request-Id}}",
"name": "externalAudienceId"
}
],
"responseErrorFields": [
{
"value": "{{root}}",
"name": "message"
}
]
},
"updateDestination": {
"url": "https://your-webhook-site/0bd222fa-8ae2-433b-8f0e-f2ce137b0ee4/{{customerData.customerID}}/updateDestination",
"httpMethod": "POST",
"headers": [
{
"value": "application/json",
"header": "Content-Type"
},
{
"value": "Bearer {{authData.token}}",
"header": "Authorization"
}
],
"requestBody": {
"json": {
"name": "{{destination.name}}",
"type": "destination",
"metadata": {
"org_id": "{{destination.imsOrgId}}",
"sandbox": "{{destination.sandboxName}}",
"destination_id": "{{destination.id}}",
"destination_name": "{{destination.name}}",
"enrichmentAttributes": "{{destination.enrichmentAttributes}}"
},
"external_id": "{{destination.id}}"
}
},
"responseFields": [
{
"value": "{{headers.X-Request-Id}}",
"name": "externalAudienceId"
}
],
"responseErrorFields": [
{
"value": "{{root}}",
"name": "message"
}
]
},
"deleteDestination": {
"url": "https://your-webhook-site/0bd222fa-8ae2-433b-8f0e-f2ce137b0ee4/{{customerData.customerID}}/deleteDestination",
"httpMethod": "DELETE",
"headers": [
{
"value": "Bearer {{authData.token}}",
"header": "Authorization"
}
],
"responseErrorFields": [
{
"value": "{{root}}",
"name": "message"
}
]
}
},
"validations":[
{
"field":"string",
"regex":"string"
}
]
}'
A successful response returns HTTP status 200 with details of your updated audience template.
Destination SDK API endpoints follow the general Experience Platform API error message principles. Refer to API status codes and request header errors in the Platform troubleshooting guide.
After reading this document, you now know when to use audience templates and how to update an audience template using the /authoring/audience-templates
API endpoint. Read how to use Destination SDK to configure your destination to understand where this step fits into the process of configuring your destination.