Channels

Set or remove attributes on channels

Changed on

Set or remove attributes on a channel. Aside from Airship's default attributes, you must define attributes in the Airship dashboard before you can set them on channels.

post/api/channels/attributes

Request

Request body

Example request

{
  "audience": {
    "amazon_channel": {
      "amazon_channel": [
        "00256e0b-b02f-4f12-a77f-4c3d57078330",
        "f59970d3-3d42-4584-907e-f5c57f5d46a1"
      ]
    },
    "android_channel": {
      "android_channel": [
        "00256e0b-b02f-4f12-a77f-4c3d57078330",
        "f59970d3-3d42-4584-907e-f5c57f5d46a1"
      ]
    },
    "channel": {
      "channel": [
        "00256e0b-b02f-4f12-a77f-4c3d57078330",
        "f59970d3-3d42-4584-907e-f5c57f5d46a1"
      ]
    },
    "email_address": [
      "00256e0b-b02f-4f12-a77f-4c3d57078330",
      "f59970d3-3d42-4584-907e-f5c57f5d46a1"
    ],
    "ios_channel": {
      "ios_channel": [
        "00256e0b-b02f-4f12-a77f-4c3d57078330",
        "f59970d3-3d42-4584-907e-f5c57f5d46a1"
      ]
    },
    "web_channel": [
      "00256e0b-b02f-4f12-a77f-4c3d57078330",
      "f59970d3-3d42-4584-907e-f5c57f5d46a1"
    ]
  }
}

Response

The operation was successful.

okboolean

If true, your request was successful.

warningstring

Alerts you if your request could not be processed. You may receive a 200 with a warning if you provide a value that does not match your attribute type. For example, an attribute that expects a numeric value will allow a value of "25" but fail if you input "twenty-five".

Changes

    • breaking

      removed subschema #2 from the // request property oneOf list

    • breaking

      removed subschema #2 from the // request property oneOf list

    • breaking

      removed subschema #2 from the // request property oneOf list

    • breaking

      removed subschema #2 from the // request property oneOf list

    • breaking

      removed subschema #3 from the //// request property oneOf list

    • info

      added to the //// request property oneOf list

    • info

      added to the // request property oneOf list

    • info

      added to the // request property oneOf list

    • info

      added to the // request property oneOf list

    • info

      added to the // request property oneOf list

    This list may be incomplete.

    • breaking

      removed subschema #1: Set Attribute subschema #2: Remove Attribute from the // request property oneOf list

    This list may be incomplete.