Audience Mapping API

Description

• Import the Audience Mapping table from different sources, such as CRM, offline sources, etc.

API URL

• https://api.omnisegment.com/api/v1/audiences/audiences-mapping/?tid=OA-xxxxxx

API Method

• POST

Request Headers:

X-OmniSegment-Api-Key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Required Fields

Parameter	Description	Sample	Data Type	Required	Note
source_id	The unique ID of the client	"12345"	string	✔	Represents the client's unique identifier
source_system	The system category	"CRM"	string	✔	Indicates the category of the system (e.g., CRM, offline)
mapping_key	The key used to find corresponding audience in our system	"phone"	string	✔	Can be one of: member_sn, phone, email, line_id
member_sn/phone/email/line_id	The value corresponding to the mapping key	"+886987654321"	string	✔	Required if mapping_key is used; should match the mapping_key value (e.g., if mapping_key is "phone", provide "phone": "+886987654321")

• Note: If the source_id is not found in OS system, a headless audience will be created and associated with the source_id(except member_sn key). Later, when member_sn and merged phone data is received, these audiences will be mapped accordingly.

Response

{
    "SUCCESS": true,
    "PAYLOAD": null
}

Example

curl --location --request POST 'https://api.omnisegment.com/api/v1/audiences/audiences-mapping/?tid=OA-xxxxxx'
--header 'X-OmniSegment-Api-Key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
--data-raw '{
    "source_id": "12345",
    "source_system": "CRM",
    "mapping_key": "phone",
    "phone": "+886987654321"
}'