Sign in
Subscribers

Update a subscriber

Update a subscriber with new values.

This is non-destructive operation, omitted parameters will not affect the subscriber.

put/1/newsletters/{domain}/subscribers/{subscriber}

Path parameters

domaininteger required

Unique identifier of the Domain

subscriberinteger required

Unique identifier of the Subscriber

Query parameters

withstring

Optional : Allows loading additional data about a resource, which may include related resources.

Request body

fieldsstring[]

Object keys must correspond to field's key. Omitted values will be deleted.

groupsstring[]

An array of valid identifiers or the names of groups to be created.

status'active' | 'unsubscribed'

Status of the resource {name}

Response

OK

result'success' | 'error' | 'asynchronous' required

Result of the HTTP request

Example response

{
  "result": "success"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.