Skip to main content

Create Subscriber Token

POST 
/subscribers/tokens

Create a Subscriber Token

Request​

Body

required

    reference stringrequired

    A string that uniquely identifies the subscriber. Often it's an email, but can be any other string.

    Example: john.doe@example.com
    expire_at integer

    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'

    Example: 1693823284
    application_id uuid

    Universal Unique Identifier.

    password string

    Set or update the subscriber's password. Omit this field or pass an empty string if you don't want to update the password.

    Example: password123
    first_name string

    Set or update the first name of the subscriber.

    Example: John
    last_name string

    Set or update the last name of the subscriber.

    Example: Doe
    display_name string

    Set or update the display name of the subscriber.

    Example: John Doe
    job_title string

    Set or update the job title of the subscriber.

    Example: Software Engineer
    time_zone string

    Set or update the time zone of the subscriber.

    Example: America/New_York
    country string

    Set or update the country of the subscriber.

    Example: US
    region string

    Set or update the region of the subscriber.

    Example: CA
    company_name string

    Set or update the company name of the subscriber.

    Example: SignalWire

Responses​

The request has succeeded.

Schema

    subscriber_id uuidrequired

    Universal Unique Identifier.

    token uuidrequired

    Universal Unique Identifier.