Skip to main content

Create Subscriber Token

POST 
/subscribers/tokens

Create a Subscriber Token

Request​

Body

required

    referencestringrequired

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

    Example: john.doe@example.com
    expire_atinteger

    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_iduuid

    Universal Unique Identifier.

    passwordstring

    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_namestring

    Set or update the first name of the subscriber.

    Example: John
    last_namestring

    Set or update the last name of the subscriber.

    Example: Doe
    display_namestring

    Set or update the display name of the subscriber.

    Example: John Doe
    job_titlestring

    Set or update the job title of the subscriber.

    Example: Software Engineer
    time_zonestring

    Set or update the time zone of the subscriber.

    Example: America/New_York
    countrystring

    Set or update the country of the subscriber.

    Example: US
    regionstring

    Set or update the region of the subscriber.

    Example: CA
    company_namestring

    Set or update the company name of the subscriber.

    Example: SignalWire

Responses​

The request has succeeded.

Schema

    subscriber_iduuidrequired

    Universal Unique Identifier.

    tokenuuidrequired

    Universal Unique Identifier.

Last updated on