Campaigns can be created on the platform or programmatically via API.
To create a campaign, certain parameters are required, such as the desired target. All existing procedures, together with their parameters and associated values, can be retrieved via the dedicated endpoint
/groups/{id}/targeting-procedures.
Recovering parameterized procedures
The API offers the option of recovering all parameterized procedures:
- For a specific group,
- For all channels: email, SMS and push notification.
This information is necessary for the creation of tactical and trigger api campaigns. The table below details the correspondence between the fields retrieved via the parameterized procedures endpoint and the campaign creation endpoint
Endpoint fields for retrieving parameterized procedures |
Campaign creation endpoint fields |
Comment |
|---|---|---|
id |
target.procedure_id | |
parameters.name and parameters.options.id |
target.parameters | parameters names are case-sensitive |
Conclusion
Once the targeting identifiers are known, creating a campaign via the API becomes possible.
Further reading: