(client, sender_id) pair becomes one authorisation and emails the owner’s representative a secure one-time link. The link is sent only to the owner by email and is never returned in the API response.
Processing is best-effort per pair: one invalid Sender ID does not sink the batch. Each pair returns its own status.
Required permission: authorisations:write
Before anything is created
Your organisation must be an approved participant in the country’s SMS Sender ID scheme register. This is the same check the Senderz webform applies before Entity Associate intake. If the check does not pass, the request creates nothing and sends no email.
Use Scheme participation check to confirm your status in advance.
Request body
string
required
Market for all authorisations in this batch. ISO 3166-1 alpha-2 (e.g.
AU).array
required
One or more Brand Owner clients.
Response
Returns201 when at least one authorisation was created, or 207 when every pair failed.
string
Batch identifier for this request.
array
One entry per
(client, sender_id) pair.object
Counts:
clients, requested, created, failed.Example
201
Sandbox keys validate the request and return simulated results without running the participation check or sending email. Sandbox responses include a placeholder link for integration testing only; live responses never include one.
.jpg?fit=max&auto=format&n=IhWYk8R5R6sdJ_7C&q=85&s=7e3194d82fa9653ad2a2449b4f1a3073)