Skip to main content

Run Command​

Endpoint to execute a command and change a subscriber's data.

Query Parameters
  • site_uuid string required

    Your site's unique identifier.

Request Body
  • command object[] required
  • Array [
  • command string

    Possible values: [add_tag, add_tag_via_event, remove_tag, add_field, remove_field, subscribe, unsubscribe, change_email]

    The command to execute.

  • email string

    The email address of the subscriber.

  • query object

    The query to execute for the command.

  • oneOf
  • string
  • ]
Responses

Returns the visitor with their updated values.

Schema
  • data object
  • id string

    The unique identifier for the command.

  • type string

    The type of the data.

  • attributes object
  • uuid string

    The UUID of the visitor.

  • email string

    The email of the visitor.

  • fields object

    Additional fields related to the visitor.

  • cached_tag_ids string[]

    An array of cached tag IDs associated with the visitor.

Loading...