Create Subscriber invite token

POST

https://{your_space_name}.signalwire.com/api/fabric/subscriber/invites

POST

/api/fabric/subscriber/invites

$ curl -X POST https://{your_space_name}.signalwire.com/api/fabric/subscriber/invites \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "address_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
> }'

1 {
2   "token": "eyJhbGciOiJkaXIiLCJlbmMiOiJBMjU2R0NNIiwiY2giOiJwdWMuc2lnbmFsd2lyZS5jb20iLCJ0eXAiOiJTQVQifQ..8O4EJs349q97jAcd.H4GNrC6gsWdz91ArWF9ce00Cm62iHfsrFRRUUGW3e96j9C3IphiJXvHYHTmD4qMt8czZ8cniF8c53vVAIZF-yBQibejiMxwnqW6KkLct2EJoPUf9g-wQwM0-lGGj9iPx_7yprkQekFK-7svkLcKlo1voZyavxIsWQlXByppmR_ospVx2u8jbAab0ZjKJNEnr1yPF9oNkyMAnkpkS8k8PwKaxUHBc5SGumKlexUjL3ixZDR6UOcbApVXxrB-DmQBs3otOT7hzME7oKvR-6Xy0XJ1pt4Of7MEzNBUK5Z5NMjtFiA8IqwDlNJz3I5gn8hbjSZwSMJHRJGx2DKpNKiu6fcd-3i2VwCpnKHaNUybMJ5gV3cTNfTFJQBSearCLv-7gMx6Gqy9FF_Hm2bGlfnjTQ9BCsCqXBkQ9EQD6yboi2uUhPyLmpzPqlrBc9ik0c3qR5ey5Jym_VnZXaT_S5NxjzIjLzvs33GOKiooGMsBWOm6mzTPcf398xaSErT4dF2wXwtZANou7Dt4BoTKa.DcLVYpma-iItaGhaOStu9A"
3 }

Creates a Subscriber Invite Token for use with client-side API calls. Authenticate this request with a subscriber’s SAT (Subscriber Access Token), not the project level Basic Auth.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice, Messaging, Fax, or Video.

Learn more about API scopes.

Creates a [Subscriber](/docs/platform/subscribers) Invite Token for use with client-side API calls. Authenticate this request with a subscriber's SAT (Subscriber Access Token), not the project level Basic Auth. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBearer

SignalWire Bearer Token Authentication for subscriber endpoints. The client sends HTTP requests with the Authorization header containing the word Bearer followed by a space and the subscriber token.

Example:

Authorization: Bearer <subscriber_token>

SignalWire Bearer Token Authentication for subscriber endpoints. The client sends HTTP requests with the Authorization header containing the word Bearer followed by a space and the subscriber token. Example: ``` Authorization: Bearer <subscriber_token> ```

Request

This endpoint expects an object.

address_idstringRequiredformat: "uuid"

Unique ID of a Subscriber Address

expires_atintegerOptional

A unixtime (the number of seconds since 1970-01-01 00:00:00) at which the token should no longer be valid. Defaults to ‘two hours from now’

Response

The request has succeeded and a new resource has been created as a result.

tokenstringformat: "jwt"

Invite Token

Errors

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error