Create or modify attributes for a person in multiple buckets

Create new attributes or modify existing attributes for a person in one or more attribute buckets. The request body should be a nested object, with bucket names as top-level keys, and key-value pair attributes as values, as shown in the example request body. The buckets must exist and must be accessible by the organization identified in the request header. Attribute names may be at most 70 bytes long. Attribute values must be JSON-serializable and are limited to 64KiB. Any existing attribute that isn't referenced by key in the request is left untouched.

Path Parameters

person_id string required
The person ID
Example: 903c1ff9-f2cc-435c-b242-9d8a690fcf0a

Header Parameters

SlashID-OrgID string required
The organization ID
Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1

application/json

Request Body required

property name*

Responses

No content

Bad Request

application/json

Schema
Example (from schema)

Schema

meta object
pagination object
limit integer
offset integer
total_count int64
cursor_pagination object
Cursors are opaque. Follow the tokens the server returns; never construct, parse or modify one.
limit integer
next_cursor string
Opaque token addressing the next page. Absent on the last page.
prev_cursor string
Opaque token addressing the previous page. Absent on the first page.
last_cursor string
Opaque token addressing the final page directly, so a client can jump to the end without a total count.
total_count int64
Total number of matching items. Returned on the FIRST page only; clients cache it for the remainder of the walk.
errors object[]
httpcode integer
message string

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total_count": 0
    },
    "cursor_pagination": {
      "limit": 0,
      "next_cursor": "string",
      "prev_cursor": "string",
      "last_cursor": "string",
      "total_count": 0
    }
  },
  "errors": [
    {
      "httpcode": 0,
      "message": "string"
    }
  ]
}

Unauthorized

application/json

Schema
Example (from schema)

Schema

meta object
pagination object
limit integer
offset integer
total_count int64
cursor_pagination object
Cursors are opaque. Follow the tokens the server returns; never construct, parse or modify one.
limit integer
next_cursor string
Opaque token addressing the next page. Absent on the last page.
prev_cursor string
Opaque token addressing the previous page. Absent on the first page.
last_cursor string
Opaque token addressing the final page directly, so a client can jump to the end without a total count.
total_count int64
Total number of matching items. Returned on the FIRST page only; clients cache it for the remainder of the walk.
errors object[]
httpcode integer
message string

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total_count": 0
    },
    "cursor_pagination": {
      "limit": 0,
      "next_cursor": "string",
      "prev_cursor": "string",
      "last_cursor": "string",
      "total_count": 0
    }
  },
  "errors": [
    {
      "httpcode": 0,
      "message": "string"
    }
  ]
}

Forbidden

application/json

Schema
Example (from schema)

Schema

meta object
pagination object
limit integer
offset integer
total_count int64
cursor_pagination object
Cursors are opaque. Follow the tokens the server returns; never construct, parse or modify one.
limit integer
next_cursor string
Opaque token addressing the next page. Absent on the last page.
prev_cursor string
Opaque token addressing the previous page. Absent on the first page.
last_cursor string
Opaque token addressing the final page directly, so a client can jump to the end without a total count.
total_count int64
Total number of matching items. Returned on the FIRST page only; clients cache it for the remainder of the walk.
errors object[]
httpcode integer
message string

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total_count": 0
    },
    "cursor_pagination": {
      "limit": 0,
      "next_cursor": "string",
      "prev_cursor": "string",
      "last_cursor": "string",
      "total_count": 0
    }
  },
  "errors": [
    {
      "httpcode": 0,
      "message": "string"
    }
  ]
}

Not Found

application/json

Schema
Example (from schema)

Schema

meta object
pagination object
limit integer
offset integer
total_count int64
cursor_pagination object
Cursors are opaque. Follow the tokens the server returns; never construct, parse or modify one.
limit integer
next_cursor string
Opaque token addressing the next page. Absent on the last page.
prev_cursor string
Opaque token addressing the previous page. Absent on the first page.
last_cursor string
Opaque token addressing the final page directly, so a client can jump to the end without a total count.
total_count int64
Total number of matching items. Returned on the FIRST page only; clients cache it for the remainder of the walk.
errors object[]
httpcode integer
message string

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total_count": 0
    },
    "cursor_pagination": {
      "limit": 0,
      "next_cursor": "string",
      "prev_cursor": "string",
      "last_cursor": "string",
      "total_count": 0
    }
  },
  "errors": [
    {
      "httpcode": 0,
      "message": "string"
    }
  ]
}

Create or modify attributes for a person in multiple buckets​

Create or modify attributes for a person in multiple buckets