Contacts

Scoped contact batch operations

Changed on

Performs one or more scoped operations on a contact in a single request. The body is a scoped array, and each item has a scope and one or more operations. Behavior matches the equivalent single-operation APIs. For each scope:

  • Subscription list operations are supported. You can subscribe and/or unsubscribe the contact to/from subscription lists for that scope, which is the same behavior as the subscription list APIs.
  • Tag operations are not supported. If tags is present in any scoped item, the request is rejected with 400 and an error indicating that tags are not allowed in this context.

The following apply:

  • Set operations are not supported.
  • Failure to authorize on secure tags results in a 200 and warning.
  • Failure to find any valid tag groups results in a 200 and warning.
  • Failure to find any valid attributes results in a 200 and warning.
post/api/contacts/scoped/{contact_id}

Request

Path parameters

contact_idstring uuid required

A string (UUID) value identifying the contact with no leading or trailing whitespace.

Request body

Response

The request was accepted.

okboolean required

Whether the operation was successful.

subscription_list_warningsstring[]

Any warnings related to subscription list operations.

tag_warningsstring[]

Any warnings related to tag operations.

Changes