Create destinations for a segment
Learn more about the Segmentation Api to create a new destination.
This Activation Service API will enable you to create a new destination schedule for a segment in a tenant. In the Segments page in the Hub, when you add a downstream system for a segment with a sync schedule, the POST destination API is invoked and all details are stored in the destination object.
Request
POST /api/[env]/[tenant]/destinations | Parameter | Required | Description | |
|---|---|---|---|
| Headers | Authorization
| Yes | Information about authentication access token in the format "Bearer <accessToken>". For more information, see Authentication API. |
Request body
| Parameter | Type | Description |
|---|---|---|
| segmentUri | String | The segment URI for which you want to retrieve destinations. |
| integrationId | String | The UUID of the integration |
| type | The type of schedule, which can be One time or Recurring. | |
| schedule | String | For the Recurring type, enter a string with a recurring rule based on RFC 5545. For the One time type, enter a date. |
Response
| Parameter | Type | Description |
|---|---|---|
| success | boolean | True for success response |
| error | Error | Error object for details |
| result | Destination | The destination object |
| result.id | String | UUID of the destination |
| result.integrationId | String | UUID of the integration |
| result.type | Type of schedule, which can be One time or recurring. | |
| result.schedule | String | Can be one of the following:
|
| result.segmentUri | String | The segment URI to get details about the segment. |