How can I use Public API to connect a destination to an audience with Default Setup event settings and enable the Send Identify option? – Twilio Support

Question

How can I use Public API to connect a destination to an audience with Default Setup event settings and enable the Send Identify option?

Product

Twilio Segment

Environment

Segment Console

Answer

To connect a destination to an audience using the Segment Public API and apply Default Setup event settings with Send Identify enabled, include the following fields in the connectionSettings object of your API request:

{
  "destination": {
    "id": "<destinationId>",
    "type": "destination"
  },
  "connectionSettings": {
    "__segment_internal_engage_batch_sync": true,
    "audience_entered_event": "Audience Entered",
    "audience_exited_event": "Audience Exited",
    "send_identify": true,
    "send_track": false
  }
}

This configuration ensures the destination is connected with Default Setup and the Send Identify option is enabled.

Additional Information

If the settings are not reflected in the UI after the API call, verify that all required fields are included in the request body.