Named Users

Named user update

Changed on

Create or update a named user by associating/disassociating channels and adding/removing tags and attributes in a single request.

post/api/named_users/{named_user_id}

Request

Path parameters

named_user_idstring required
Example:john_doe

A string value identifying the user, without leading or trailing whitespace. If this value contains reserved or special characters they must be URL encoded.

Request body

Example request

{
  "associate": [
    {
      "channel_id": "9c36e8c7-5a73-47c0-9716-99fd3d4197d5"
    }
  ],
  "disassociate": [
    {
      "channel_id": "9c36e8c7-5a73-47c0-9716-99fd3d4197d5"
    }
  ]
}

Response

Request was accepted.

attribute_warningsstring

Warnings encountered when processing attributes for this named user.

okboolean required

Set to true when status code is 200.

tag_warningsstring

Warnings encountered when processing tags for this named user.

Changes

    • breaking

      removed subschema #1: Channel subschema #2: Email address from the / request property anyOf list

    • breaking

      removed subschema #1: Channel subschema #2: Email address from the / request property anyOf list

    • breaking

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

    • info

      added to the / request property anyOf list

    • info

      added to the / request property anyOf list

    • info

      added to the ///// request property oneOf list

    This list may be incomplete.

    • breaking

      removed subschema #2: Email Address from the / request property anyOf list

    • breaking

      removed subschema #2: Email Address from the / request property anyOf list

    • breaking

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

    This list may be incomplete.