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 associated with a contact in this workspace. A subscriber identifies the person using the service. This request does not buy an eSIM, assign a profile, or grant workspace access. It requires email_marketing:read and esim:write.
Creating this association prevents deletion of the contact, including after the assigned eSIM ends. Subscriber associations cannot currently be removed, detached, or anonymized. 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.