Create or modify attributes for the organization in a single bucket

Create new attributes or modify existing attributes for the organization in a single attribute bucket. The bucket must exist and must be accessible by the organization identified in the request header. The request body should be an object consisting of key-value pair attributes. Attribute names may be at most 70 bytes long. Attribute values must be JSON-serializable and are limited to 64KiB. Replaces the set of existing attributes with those present in the request. In other words, it deletes any existing attributes that aren't referenced by key in the request.

Path Parameters

bucket_name string required
The name of an attribute bucket. The bucket end_user_read_write exists for all organizations and is suitable for many common use cases. Please refer to our documentation for more information on attribute buckets.

Header Parameters

SlashID-OrgID string required
The organization ID
Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
SlashID-Required-Consistency string
Possible values: [local_region, all_regions]
Default value: local_region
The consistency level required for this request. If the consistency level is not achieved within the timeout, the request will fail with a 408 Request Timeout error. 408 Request Timeout error indicates that request was not handled within the timeout, but it may still be handled after request timeout. Allowed values: * local_region: Wait while the request executes in the local region. * all_regions: Wait while the request executes across all regions. You can learn more about our replication model on our Cross-region Replication Model page.
SlashID-Required-Consistency-Timeout integer
Possible values: >= 1 and <= 120
Default value: 30
The maximum amount of seconds to wait for the requested consistency level to be achieved. If the consistency level is not achieved within this time, the request will fail with a 408 Request Timeout error. 408 Request Timeout error indicates that request was not handled within the timeout, but it may still be handled after request timeout. You can learn more about our replication model on our Cross-region Replication Model page.

application/json

Request Body required

Responses

No content

Bad Request

application/json

Schema
Example (from schema)

Schema

meta object
pagination object
limit integer
offset integer
total_count int64
errors object[]
httpcode integer
message string

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "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
errors object[]
httpcode integer
message string

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "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
errors object[]
httpcode integer
message string

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "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
errors object[]
httpcode integer
message string

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

Create or modify attributes for the organization in a single bucket​

Create or modify attributes for the organization in a single bucket