AIairship
Named Users

Set or remove attributes on named users

Changed on

Set or remove attributes on a named user.

A single request body may contain a set or remove field, or both, or a single set field. If both set and remove fields are present and the intersection of the attributes in these fields is not empty, then a 400 will be returned.

If an attribute request is partially valid, i.e., at least one attribute exists, Airship returns a 200 with a warning about the attributes that failed to update. The attributes listed in the warnings string will be in CSV format.

post/api/named_users/{named_user_id}/attributes

Request

Path parameters

named_user_idstring required

The named user you are setting the attributes for.

Request body

Response

Success. If an attribute request is partially valid, i.e., at least one attribute exists, Airship returns a 200 with a warning string containing a CSV list of attributes that failed to update. Airship also returns a 200 with a warning if you attempt to set attributes on a named_user, even if the named_user does not exist.

okboolean

Set to true when status code is 200.

warningsstring

Warnings encountered when updating named user attributes.

Changes

  • 38241778b0c1Revision changes
    • breaking

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

    • info

      added to the //// request property oneOf list

    This list may be incomplete.

  • 3304568aaadcRevision changes
    • breaking

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

    • breaking

      the response property became optional for the status

    This list may be incomplete.