Update an activation

Updated:

PUT/cdp/{connection_id}/activation/{id}

Parameters

fieldsstring array
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
connection_idstring required
ID of the connection
idstring required
ID of the Activation

Payload

idstring
Unique identifier for this activation object
created_atdate-time
The date that this activation object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-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 enum
Valid values:
"ACTIVE"
"PAUSED"
"ERROR"
"PENDING"
The current status of the activation
last_run_atdate-time
When the activation last ran (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
is_enabledboolean
Whether the activation is active/enabled
metadata array

Returns

Response fieldTypeRequiredDescription
idstringNoUnique identifier for this activation object
created_atstring (date-time)NoThe date that this activation object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoThe last date that this activation object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNoThe name of the activation/sync job
segment_idstringNoThe cdp_segment being activated; points to CdpSegment
destination_idstringNoThe cdp_destination the data is sent to; points to CdpDestination
source_idstringNoThe cdp_source the data originates from; points to CdpSource
schedulestringNoThe activation schedule or mode (eg. cron, interval, realtime, batch)
statusenumNoThe current status of the activation Values: ACTIVE, PAUSED, ERROR, PENDING
last_run_atstring (date-time)NoWhen the activation last ran (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
is_enabledbooleanNoWhether the activation is active/enabled
metadataCdpMetadata[]No
metadata[].idstringNo
metadata[].slugstringNoThe attribute/trait key (eg. lifetime_value)
metadata[].valueobjectNoThe attribute/trait value
metadata[].namespacestringNoThe scope or origin of the attribute (eg. computed, event, visitor)
metadata[].formatenumNoThe data type of the attribute value Values: TEXT, NUMBER, DATE, BOOLEAN, ARRAY, OBJECT
metadata[].extra_dataobjectNo

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'PUT',
  url: 'https://api.unified.to/cdp/5de520f96e439b002043d8dc/activation/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?