cdp
activation

Update an activation

Changed on
put/cdp/{connection_id}/activation/{id}

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/cdp/{connection_id}/activation/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Activation

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Request body

idstring

Unique identifier for this activation object

created_atstring date-time

The date that this activation object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

The last date that this activation object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

The name of the activation/sync job

segment_idstring

The cdp_segment being activated; points to CdpSegment

destination_idstring

The cdp_destination the data is sent to; points to CdpDestination

source_idstring

The cdp_source the data originates from; points to CdpSource

schedulestring

The activation schedule or mode (eg. cron, interval, realtime, batch)

status'ACTIVE' | 'PAUSED' | 'ERROR' | 'PENDING'

The current status of the activation

last_run_atstring date-time

When the activation last ran (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

is_enabledboolean

Whether the activation is active/enabled

rawobject

The raw data returned by the integration for this activation

Response

Successful

idstring

Unique identifier for this activation object

created_atstring date-time

The date that this activation object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

The last date that this activation object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring

The name of the activation/sync job

segment_idstring

The cdp_segment being activated; points to CdpSegment

destination_idstring

The cdp_destination the data is sent to; points to CdpDestination

source_idstring

The cdp_source the data originates from; points to CdpSource

schedulestring

The activation schedule or mode (eg. cron, interval, realtime, batch)

status'ACTIVE' | 'PAUSED' | 'ERROR' | 'PENDING'

The current status of the activation

last_run_atstring date-time

When the activation last ran (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

is_enabledboolean

Whether the activation is active/enabled

rawobject

The raw data returned by the integration for this activation

Changes

    • info

      added the new optional request property

    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status

    • info

      endpoint added