Pure CallerID provides simple endpoints to trigger opt-in and opt-out confirmation messages and suppression management at the campaign level. These endpoints are secured with a workspace API key.
Opt-In
Triggers the core campaign Opt-In confirmation text message. This endpoint will also clear any existing suppressions for this particular phone number if the user has previously opted out of the campaign.
IMPORTANT: This endpoint should be called immediately upon consent gathering via online form, lead partners, or other lead sources to ensure that the individual receives the compliant opt-in messaging at the time of opt-in.
URL: https://core.purecallerid.app/api/public/engage/optIn
Method: POST
Content-Type: application/json
Security: A custom HTTP header must be included in the request. The header name is X-API-KEY and the value is one of the encrypted API keys associated with your workspace.
Required Params
- coreCampaignId – Unique Id of the Core campaign that contains the 10DLC, Short Code, or Toll-Free messaging campaign connection.
- phoneNumber – The phone number to search (E.164 or digits).
Optional Params
- zipCode – The US ZIP code of the individuals location. Passing this value in will ensure the correct number is selected from a 10DLC number pool when sending the Opt-In confirmation.
A successful response will return a 200 OK with no body content.
Opt-Out
This endpoint will add the provided phone number to the internal suppression list as well as delivering the pre-configured opt-out text message confirmation.
URL: https://core.purecallerid.app/api/public/engage/optOut
Method: POST
Content-Type: application/json
Security: A custom HTTP header must be included in the request. The header name is X-API-KEY and the value is one of the encrypted API keys associated with your workspace.
Required Params
- coreCampaignId – Unique Id of the Core campaign that contains the 10DLC, Short Code, or Toll-Free messaging campaign connection.
- phoneNumber – The phone number to search (E.164 or digits).
Optional Params
- zipCode – The US ZIP code of the individuals location. Passing this value in will ensure the correct number is selected from a 10DLC number pool when sending the Opt-In confirmation.
A successful response will return a 200 OK with no body content.