Change a subscriber's attributes

Merges the attributes the body names into the subscriber’s (new values win, null removes a key); the status is never changed. Needs scope write. A subscriber of a deleted list takes no change.

Parameters

Name	In	Type	Description
`project_id`required	path	string · uuid	The project’s id
`subscriber_id`required	path	string · uuid	The subscriber’s id

Request body

application/json · required

UpdateSubscriberRequest object · all fields required
attributesobject

Attributes to set or remove (null).

Responses

200

The subscriber after the change

Subscriber object · all fields required
attributesobject

The subscriber’s attributes, a map of string, number or boolean values.
confirmed_atstring · date-time | null

When the subscriber confirmed a double opt-in; null otherwise.
created_atstring · date-time
emailstring · email

example ann@example.com
idstring · uuid

example 01900000-0000-7000-8000-000000000001
list_idstring · uuid

The list the subscriber is on.
project_idstring · uuid

The subscriber’s project.
soft_bounce_streakinteger · int32

Soft bounces in a row; reset by a delivery (P4+).

≥ 0
sourcestring

How the subscriber was added: api, import or confirm.
statusstring

pending, active, unsubscribed, bounced or complained.

example active
unsubscribed_atstring · date-time | null

When the subscriber unsubscribed; null otherwise.
updated_atstring · date-time

The latest change: creation, an attribute merge, a status change.

400

Not JSON (invalid_json)

Problem (application/problem+json)

401

No valid key

Problem (application/problem+json)

403

A project key without scope write (forbidden)

Problem (application/problem+json)

404

No such subscriber or project, or another project’s (not_found)

Problem (application/problem+json)

409

The subscriber’s list or project is deleted (conflict)

Problem (application/problem+json)

413

Over 10 MB (body_too_large)

Problem (application/problem+json)

415

Not application/json (unsupported_media_type)

Problem (application/problem+json)

422

Invalid attributes, every one in errors (validation_failed)

Problem (application/problem+json)

429

The key is over its rate limit, api.rate_limit_per_minute requests a minute on this node (rate_limited)

Header	Type	Description
`Retry-After`	integer	Seconds until the key’s next request passes; rounded up.

Problem (application/problem+json)

504

Postwind’s storage did not answer within its time limit (storage_timeout). A change the request makes may still take effect: check before repeating it. A repeat with the same Idempotency-Key never runs it twice: it is 409 idempotency_key_in_progress until the key’s 24 h end

Problem (application/problem+json)