Create an eSIM subscriber
POST
/v1/esim/subscribersbird esim subscribers create --contact-id con_01krdgeqcxet5s7t44vh8rt9mgcurl -X POST "https://us1.platform.bird.com/v1/esim/subscribers" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"contact_id": "con_01krdgeqcxet5s7t44vh8rt9mg"
}'Response200
{
"id": "esub_01krdgeqcxet5s7t44vh8rt9mg",
"contact_id": "con_01krdgeqcxet5s7t44vh8rt9mg",
"created_at": "2026-05-20T09:14:52Z",
"updated_at": "2026-05-25T16:42:01Z"
}
Creates or returns the subscriber for a same-workspace contact. A subscriber is a service user, not a workspace member or a billing account. No eSIM is purchased or assigned by this request. Creating the link requires Contacts read permission (email_marketing:read) in addition to esim:write. Once linked, the Contact cannot be deleted, even when no active eSIM uses the subscriber. Subscriber links cannot currently be deleted, detached, or anonymized; ending or releasing an eSIM does not restore Contact deletion.
Request Payload
contact_idstring
required
Existing contact in this workspace; requires Contacts read permission.
Response Payload
idstring
required
contact_idstring
required
created_atstring
required
updated_atstring
required
Related resources
Continue with the documentation, guides and examples for this topic.