Update an individual

PUT

/audience/management/v1/individuals/{id}

curl --request PUT \
  --url https://api.ebitex.io/audience/management/v1/individuals/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "attributes": {}, "rowVersion": 1, "displayName": "example", "locale": "example" }'

Replaces a person’s name and attributes. Send the rowVersion you read: if the person changed since, the call answers 409 concurrency_conflict and nothing is written.

Key: an Audience management key with audience.management.write (write also needs read; erase needs both).

Authorizations

• apiKey

Parameters

Path Parameters

id

required

string format: uuid

Request Body^required

Media typeapplication/json

object

name

null | string

attributes

One of:

null

null

object

object

rowVersion

null | integer | string format: uint32

/^-?(?:0|[1-9]\d*)$/

displayName

null | string

locale

null | string

Example^generated

{
  "name": "example",
  "attributes": {},
  "rowVersion": 1,
  "displayName": "example",
  "locale": "example"
}

Responses

200

{ "id", "name", "displayName", "source": { "kind", "key", "label" }, "identities": [ … ], "channelPermissions": [ … ], "visitorLinks": [ … ], "attributes": { … }, "mergedInto", "interactionCount", "createdAtUtc", "updatedAtUtc", "rowVersion" }. name is the display name, else the primary email, else the primary phone, else the first external key, else “Unnamed”.

400

validation_failed: a field is invalid; a custom field is keyed attributes.<key>.

401

missing_api_key or invalid_api_key: no key was sent, or it is unknown, revoked or expired, or it was not created from the Audience settings page.

402

payment_required: the organization’s subscription needs attention.

403

scope_denied: the key lacks this route’s scope. ip_denied: the caller’s address is outside the key’s allowed ranges. app_not_available: Audience is not enabled for the organization.

404

individual_not_found: no such person in this organization.

not_found: no such route.

409

concurrency_conflict: the person changed since rowVersion was read.

429

rate_limited: the key spent its requests-per-minute budget; Retry-After says how long to wait. too_many_failed_authentications: too many bad keys from this address.