Skip to main content
POST
/
v2
/
verification
/
management
/
sender-id
Submit a sender ID
curl --request POST \
  --url https://api.prelude.dev/v2/verification/management/sender-id \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sender_id": "<string>"
}
'
{
  "sender_id": "<string>",
  "status": "approved",
  "reason": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.prelude.so/llms.txt

Use this file to discover all available pages before exploring further.

Submit a new custom sender ID for registration on your account. Prelude reviews each submission against carrier and regional regulations before approving it for use. Once approved, the sender ID becomes available to reference in the options.sender_id field of a Create Verification request.
Access to the management API is opt-in. Contact our support team to enable it on your account. Regional rules, fees, and registration timelines vary — see the Custom Sender IDs guide for details.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
sender_id
string
required

The sender ID to add.

Example:

"Prelude"

Response

OK

​
sender_id
string
required

The sender ID that was added.

​
status
enum<string>
required

It indicates the status of the sender ID. Possible values are:

  • approved - The sender ID is approved.
  • pending - The sender ID is pending.
  • rejected - The sender ID is rejected.
Available options:
approved,
pending,
rejected
Example:

"approved"

​
reason
string

The reason why the sender ID was rejected.