Contacts

Contacts scoped batch item

Contains scope and subscription_lists and/or tags. At least one of subscription_lists or tags must be provided.

Jump to examples ↓

• scope array<Scopes>REQUIRED
• subscription_lists object<Contact subscription list object>

  Defines the subscription list changes.

• tags array[object]
  OBJECT PROPERTIES
  • add object<Tag group object>

    Add the list of tags to the named user, but do not remove any. If the tags are already present, they are not modified.

    Tag groups appear within the tags object for a named user or the tag_groups object for a channel.

    ua_ is a reserved prefix for Airship-specific tag groups. See Device property tags.

  • remove object<Tag group object>

    Remove the list of tags from the named user, but do not remove any others. If the tags are not currently present, nothing happens.

    Tag groups appear within the tags object for a named user or the tag_groups object for a channel.

    ua_ is a reserved prefix for Airship-specific tag groups. See Device property tags.

  • set object<Tag group object>

    Set these tags for the named user; any tags previously associated that are not in this current list are removed.

    Tag groups appear within the tags object for a named user or the tag_groups object for a channel.

    ua_ is a reserved prefix for Airship-specific tag groups. See Device property tags.

Used in:

• Scoped contact batch operations

Examples

{
   "scope": ["web", "email", "app"],
   "subscription_lists": {
      "subscribe": ["subscription_1", "subscription_2"],
      "unsubscribe": ["subscription_3"]
   }
}