SMS

Text a confirmation code to an owner phone

Requires owner_manage. The owner email must already be verified (HTTP 409 owner_not_verified). The number must have opted in at /sms within the last 24 hours (HTTP 409 consent_required). Sends a code on Avatar 8 LLC's verified campaign from the toll-free number. Codes are limited to 5 per hour for a number. HTTP 404 owner_not_found for another inbox's owner. HTTP 404 not_found when SMS is off. The response does not include the code.

post/api/v1/inboxes/{id}/owners/{ownerId}/phone

Request

  • Base URL: https://cooperemail.com
  • URL: https://cooperemail.com/api/v1/inboxes/{id}/owners/{ownerId}/phone
  • Auth: HTTP bearer

Path parameters

idstring required
ownerIdstring required

Request body

e164string
phonestring

Same as e164. One of the two is required.

Response

Pending or already verified owner phone. The code is not returned.

object'owner_phone' required
idstring required
owner_idstring required
inbox_idstring required
e164string required
status'pending' | 'verified' | 'toll_free_verification_pending' required
confirmed_atstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.