Heads up, our devs are blazing ahead—docs are catching up, so some features might not be fully documented yet.
Visit our websiteAPI Documentation

CustomerConsent

CustomerConsent

List consents

get

List all consents.

Required permission: TENANT.ACCESS

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Query parameters
pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional
ENUM Description
ASC Sort in ascending order
DESC Sort in descending order
Possible values:
Responses
200
Example response
application/json
get
GET /v2/tenants/{tenantUid}/consents HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "items": [
    {
      "consentUid": "text",
      "name": "text",
      "description": "text",
      "active": true,
      "createdAt": "2025-07-30T18:09:46.444Z",
      "createdBy": "text",
      "lastModifiedAt": "2025-07-30T18:09:46.444Z",
      "lastModifiedBy": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Create a new consent

post

Create a new consent type

Required permission: TENANT.ADMIN

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
Body
consentUidstringOptionalPattern: ^[A-Za-z0-9-_]+
namestringRequired
descriptionstringOptional
activebooleanRequired
Responses
201
Example response
application/json
post
POST /v2/tenants/{tenantUid}/consents HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "consentUid": "text",
  "name": "text",
  "description": "text",
  "active": true
}
201

Example response

{
  "consentUid": "text",
  "name": "text",
  "description": "text",
  "active": true,
  "createdAt": "2025-07-30T18:09:46.444Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-07-30T18:09:46.444Z",
  "lastModifiedBy": "text"
}

Get consent

get

Get a consent type

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
consentUidstringRequired

Reference to a consent

Responses
200
Example response
application/json
get
GET /v2/tenants/{tenantUid}/consents/{consentUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "consentUid": "text",
  "name": "text",
  "description": "text",
  "active": true,
  "createdAt": "2025-07-30T18:09:46.444Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-07-30T18:09:46.444Z",
  "lastModifiedBy": "text"
}

Update consent

put

Update a consent typ

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
consentUidstringRequired

Reference to a consent

Body
namestringOptional
descriptionstringOptional
activebooleanOptional
Responses
200
Example response
application/json
put
PUT /v2/tenants/{tenantUid}/consents/{consentUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "name": "text",
  "description": "text",
  "active": true
}
200

Example response

{
  "consentUid": "text",
  "name": "text",
  "description": "text",
  "active": true,
  "createdAt": "2025-07-30T18:09:46.444Z",
  "createdBy": "text",
  "lastModifiedAt": "2025-07-30T18:09:46.444Z",
  "lastModifiedBy": "text"
}

Delete a consent

delete

Delete a consent type

Authorizations
Path parameters
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
consentUidstringRequired

Reference to a consent

Responses
204
No Content
delete
DELETE /v2/tenants/{tenantUid}/consents/{consentUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204

No Content

No content

List consent history for a customer

get

List the history of a specific consent type for a customer.

The list is sorted by createdAt, where the newest history element is first

Authorizations
Path parameters
customerUidstringRequired

Reference to a Customer.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
consentUidstringRequired

Reference to a consent

Responses
200
Example response
application/json
get
GET /v2/tenants/{tenantUid}/customers/{customerUid}/consents/{consentUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Example response

{
  "items": [
    {
      "consentUid": "text",
      "name": "text",
      "status": true,
      "source": "text",
      "createdAt": "2025-07-30T18:09:46.444Z"
    }
  ]
}

Add a consent change to a customer

post

Add a consent change to a custom

Authorizations
Path parameters
customerUidstringRequired

Reference to a Customer.

Pattern: ^[A-Za-z0-9-_]+
tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+
consentUidstringRequired

Reference to a consent

Body
sourcestringRequired
statusbooleanRequired

Is the consent active or withdrawn

Responses
200
Example response
application/json
post
POST /v2/tenants/{tenantUid}/customers/{customerUid}/consents/{consentUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "source": "text",
  "status": true
}
200

Example response

{
  "consentUid": "text",
  "name": "text",
  "status": true,
  "source": "text",
  "createdAt": "2025-07-30T18:09:46.444Z"
}
PreviousCustomerAddressNextCustomerContact

Was this helpful?