Path parameters

• DomainSid string Required

  Unique string used to identify the domain that this config should be associated with.

  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^DN[0-9a-fA-F]{32}$.

Responses

• 200 application/json

  OK

  Hide headers attributes Show headers attributes

  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

  • domain_sid string | null

    The unique string that we created to identify the Domain resource.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^DN[0-9a-fA-F]{32}$.

  • config_sid string | null

    The unique string that we created to identify the Domain config (prefix ZK).

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^ZK[0-9a-fA-F]{32}$.

  • fallback_url string(uri) | null

    Any requests we receive to this domain that do not match an existing shortened message will be redirected to the fallback url. These will likely be either expired messages, random misdirected traffic, or intentional scraping.

  • callback_url string(uri) | null

    URL to receive click events to your webhook whenever the recipients click on the shortened links.

  • continue_on_failure boolean | null

    Boolean field to set customer delivery preference when there is a failure in linkShortening service

  • date_created string(date-time) | null

    Date this Domain Config was created.

  • date_updated string(date-time) | null

    Date that this Domain Config was last updated.

  • url string(uri) | null
  • disable_https boolean | null

    Customer's choice to send links with/without "https://" attached to shortened url. If true, messages will not be sent with https:// at the beginning of the url. If false, messages will be sent with https:// at the beginning of the url. False is the default behavior if it is not specified.

• 201 application/json

  Created

  Hide headers attributes Show headers attributes

  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

  • domain_sid string | null

    The unique string that we created to identify the Domain resource.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^DN[0-9a-fA-F]{32}$.

  • config_sid string | null

    The unique string that we created to identify the Domain config (prefix ZK).

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^ZK[0-9a-fA-F]{32}$.

  • fallback_url string(uri) | null

    Any requests we receive to this domain that do not match an existing shortened message will be redirected to the fallback url. These will likely be either expired messages, random misdirected traffic, or intentional scraping.

  • callback_url string(uri) | null

    URL to receive click events to your webhook whenever the recipients click on the shortened links.

  • continue_on_failure boolean | null

    Boolean field to set customer delivery preference when there is a failure in linkShortening service

  • date_created string(date-time) | null

    Date this Domain Config was created.

  • date_updated string(date-time) | null

    Date that this Domain Config was last updated.

  • url string(uri) | null
  • disable_https boolean | null

    Customer's choice to send links with/without "https://" attached to shortened url. If true, messages will not be sent with https:// at the beginning of the url. If false, messages will be sent with https:// at the beginning of the url. False is the default behavior if it is not specified.