Custom Attributes¶

Set custom name-value attributes on a user's application.

Authentication

All methods require a valid Platform API key in the x-yappes-key header.

Base URL

Substitute the sample host https://platformapi.enterprise-xyz.com with the Platform API URL configured for your Yappes organization, since the host value changes depending on the organization and deployment setup.

REST Resources¶

Resource	Methods
organizations.users.apps.attributes	create

Resource: organizations.users.apps.attributes¶

Custom attribute management on a user's application.

Platform API — Configure Product Attributes¶

Sets custom attributes on a user's app. You only supply the attribute array in the request body; other application settings are preserved automatically. Attribute names are required; values are optional strings.

HTTP request¶

POST https://platformapi.enterprise-xyz.com/v1/organizations/{organizationReferenceId}/users/{userReference}/apps/{appReference}/attributes

Path parameters¶

Parameter	Type	Description
`organizationReferenceId`	string	Required. Organization reference (id, reference name, or organization name).
`userReference`	string	Required. User reference (`userId`, email, or username).
`appReference`	string	Required. Application id (`APP-…`) or application name.

Query parameters¶

None.

Request body¶

{
  "attribute": [
    { "name": "environment", "value": "production" },
    { "name": "rateplan", "value": "Gold" },
    { "name": "department", "value": "Finance" }
  ]
}

Field	Type	Required	Description
`attribute`	array	No	List of attributes to set. An empty array clears or replaces with no attributes.
`attribute[].name`	string	Yes	Attribute name. Empty or missing name returns `400`.
`attribute[].value`	string	No	Attribute value. `null` or omitted values become `""`.

Response body¶

If successful, the response body contains an instance of Attributes echoing the submitted attributes:

{
  "attribute": [
    { "name": "environment", "value": "production" },
    { "name": "rateplan", "value": "Gold" },
    { "name": "department", "value": "Finance" }
  ]
}

Errors¶

HTTP status	Condition
`400`	Missing `attribute[].name`, application has no linked plans (`selectedIds`), or validation error.
`404`	Organization, user, or application not found. User is not a member of the organization.
`502`	Service unreachable.
Other	Non-2xx responses may be returned with the original status and body.

Example validation error:

{
  "code": 400,
  "name": "parameter-error",
  "message": "planDetails are required when isCustomRatePlan is true."
}

Authorization¶

Requires a valid x-yappes-key header.

Method index¶

#	HTTP	Path
1	POST	`/v1/organizations/{organizationReferenceId}/users/{userReference}/apps/{appReference}/attributes`