Set a phone number · BeaconBox docs

Request

curl -X PUT https://api.beaconbox.eu/api/v1/recipients/buyer@example.com/phone \
  -H "Authorization: Bearer $BEACONBOX_API_KEY" \
  -H "Content-Type: application/json"
  -d '{
       "phone": "+37255550134"
     }'

curl -X PUT https://api.beaconbox.eu/api/v1/recipients/buyer@example.com/phone \
  -H "Authorization: Bearer $BEACONBOX_API_KEY" \
  -H "Content-Type: application/json"
  -d '{
       "phone": "+37255550134"
     }'

client.recipients.set_phone(email, phone)

client.recipients.set_phone(email, phone)

$client->recipients->setPhone($email, $phone)

$client->recipients->setPhone($email, $phone)

Path parameters

Name	Type	Description
`email`	`email`

Body

Field	Type	Description
`phone` required	`string`	Mobile number, E.164 preferred (e.g. +372 5555 0134).

Response

Returns 200.

Field	Type	Description
`recipient_email`	`string`
`phone`	`string \| null`	Masked, e.g. "+372 •••• 0134". None if no number is stored.
`sms_status`	`"none" \| "active" \| "stopped"`
`sms_status_at`	`date-time \| null`
`sms_consent_at`	`date-time \| null`	When a number was first accepted for texting this recipient. Null for a recipient who has never had one, or whose number predates this field.
`sms_consent_source`	`string \| null`	The surface that first accepted it: "push" (recipient_phone on a push), "api" (PUT /recipients/{email}/phone), "admin" (the recipient page) or "inbox".

Errors

Failures are { "error_code": "..." } with a stable dotted code. See Errors for the codes worth branching on and the three outcomes that look like failures and are not.