Open Channels

Register new or update channel

Create a new open channel or update an existing open channel.

post/api/channels/open

Request

Base URL
https://go.urbanairship.com
Auth
- HTTP basic
- or HTTP bearer
- or OAuth 2
  Client credentials
  Token URLhttp://oauth2.{domain}.com/token
  Scopeschn
TypeScript
https://skmtc.dev/airship/apis/airship-api/docs/api/channels/open/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

Example request

{
  "channel": {
    "address": "+1 5558675309",
    "locale_country": "US",
    "open": {
      "identifiers": {
        "baz": "lurhmann",
        "foo": "bar"
      }
    },
    "tags": [
      "one_tag",
      "two_tag",
      "red_tag",
      "blue_tag"
    ],
    "timezone": "America/Los_Angeles"
  }
}

Response

Returned if the new channel is created successfully or if an existing channel was found for the specified open_platform_name and address.

channel_idstring uuid

Identifies the new open channel or the open channel you successfully updated.

okboolean

Success.

Example response

{
  "channel_id": "ef625038-70a3-41f1-826f-57bc11dd625a"
}

Changes

No recorded changes to this operation across all 9 revisions of this API.