Add a person to an account

PUT

/audience/management/v1/accounts/{externalId}/members/{individualId}

const url = 'https://api.ebitex.io/audience/management/v1/accounts/example/members/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"role":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://api.ebitex.io/audience/management/v1/accounts/example/members/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "role": "example" }'

Adds the person to the account, or changes their role. { "role" }: an optional label of up to 100 characters that you choose; Audience does not read it. The same call twice changes nothing. A person who was merged into another cannot be added.

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

Authorizations

apiKey

Parameters

Path Parameters

externalId

required

string

individualId

required

string format: uuid

Request Body

application/json

One of:

null
object

null

Example^generated

{
  "role": "example"
}

Responses

200

{ "accountId", "individualId", "added" }. 201 when the membership is new, 200 when it already existed.

400

validation_failed: the role is too long.

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

account_not_found or individual_not_found.

not_found: no such route.

409

accounts_not_enabled: the organization has not turned accounts on.

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.