Skip to main content
GET
Get sender ID
Required scope: PARTNER
Returns a sender ID declared on one of your accounts, with its review status. The partner.sender_id.validated and partner.sender_id.failed webhooks tell you when the review ends. Without a webhook endpoint, poll this endpoint instead, within the rate limit of 20 read requests per second per key. Allo sends no webhook when a sender ID becomes DISABLED. Read this endpoint to check that a validated sender ID is still usable. An id that is not a sender ID of this account fails with 404 PARTNER_SENDER_ID_NOT_FOUND. An account your API key did not create returns 404 PARTNER_ACCOUNT_NOT_FOUND.

Authorizations

Authorization
string
header
required

Path Parameters

account_id
string
required

The account id returned by Create account (usr-*).

id
string
required

The sender ID's id returned by Declare sender ID (vsi-*).

Response

Sender ID

data
object

An alphanumeric sender ID declared on an account you provisioned.