Integration Platform

Endpoints supporting configuration of Integration Platform (IP) backed sources.

IntegrationContext

The resolved Integration Platform (IP) instance identifiers for a reused IP-backed source entity. The frontend uses these values to build its configure call when re-adding the entity to another flow.

integration_instance_id
required
string

The IP integration instance identifier associated with the entity's credential.

connection_instance_id
required
string

The IP connection instance identifier associated with the entity's credential.

marketplace_app_id
required
string

The IP marketplace app identifier associated with the entity's credential.

{
  • "integration_instance_id": "int_inst_9f8b7c6d5e4f3a2b1c0d9e8f",
  • "connection_instance_id": "conn_inst_1a2b3c4d5e6f7a8b9c0d1e2f",
  • "marketplace_app_id": "app_0d1e2f3a4b5c6d7e8f9a0b1c"
}

Resolve integration context for an IP-backed entity

Resolves the Integration Platform (IP) "integration context" for a reused IP-backed source entity so the frontend can build its configure call when the entity is re-added to another flow.

Returns the IP instance identifiers (integration_instance_id, connection_instance_id, marketplace_app_id) resolved from the entity's IP credential.

This endpoint is gated by the enable-snapchat-lead-ads feature flag and responds with 404 Not Found when the flag is disabled.

SecurityAPIKey
Request
path Parameters
entity_id
required
string (EntityID) ^[0-9a-fA-F]{24}$

The 24-character hexadecimal identifier of the IP-backed source entity.

Example: 5fd4371e940df5a34a3888b2
Responses
200

The resolved integration context for the entity.

400

Bad request — entity_id is not a 24-character hexadecimal string.

401

Authorization information is missing or invalid.

403

Forbidden — the entity is not owned by the calling account.

404

Not found. Two distinct cases share this status:

  • Flag disabled: the enable-snapchat-lead-ads feature flag is off; the response body is empty.
  • Entity not found: the entity does not exist; the response body is an LCError JSON object.
422

Unprocessable — the entity is not a custom IP inbound entity, or no IP credential could be resolved for it.

get/integration_platform/entities/{entity_id}/context
Request samples
Response samples
application/json
{
  • "integration_instance_id": "int_inst_9f8b7c6d5e4f3a2b1c0d9e8f",
  • "connection_instance_id": "conn_inst_1a2b3c4d5e6f7a8b9c0d1e2f",
  • "marketplace_app_id": "app_0d1e2f3a4b5c6d7e8f9a0b1c"
}