latestOpenAPI 3.1.02026-08-085123123.9 KB

bf0b51ee8e8a

Members

Set consent for a specific member

Set consent for a specific member based on their key. Note: Some consent types cannot be overridden — this method returns a 422 status code with a message when that happens.

put/members/{key}/consent

Path parameters

keystring required

Can be either the member's email address or their numerical ID

Request body

relationType'express-consent' | 'active-clients' | 'information-request' | 'business-card' | 'web-contacts' | 'purchased-list' | 'contest-participants' | 'mixed-list' | 'association-members' | 'employees' | 'partners' | 'inactive-clients' required

Accepted values: express-consent, active-clients, information-request, business-card, web-contacts, purchased-list, contest-participants, mixed-list, association-members, employees, partners, inactive-clients

consentDatestring nullable

Format Y-m-d

consentProofstring

Example request

{
  "relationType": "active-clients",
  "consentDate": "2022-01-01",
  "consentProof": "Customer since 2015, see invoices"
}

Response

The new consent attributes for the specified member

consentTypestring
relationTypestring
consentDatestring nullable
consentExpirationstring nullable
consentProofstring

Example response

{
  "consentType": "implied",
  "relationType": "active-clients",
  "consentDate": "2022-01-01 00:00:00.000",
  "consentExpiration": "2024-01-01 00:00:00.000",
  "consentProof": "Customer since 2015, see invoices"
}