Consent

List consents

GET https://app.bookboost.io/api/v2/partners/resources/app/{id}/consents

Path Parameters

NameTypeDescription

id*

String

ID of an app within organization

Headers

NameTypeDescription

Authorization

String

Organization API key

[
    {
        "id": "396326ec-2447-648h-b297-da0a81b57b50",
        "name": "Marketing consent",
        "code": "MKT",
        "type": "Marketing",
        "consent_body": "I would like to receive the newsletter",
        "description": "Promotional mobile messages"
    },
    ...
]

POST https://app.bookboost.io/api/v2/partners/resources/app/{id}/consents

Path Parameters

NameTypeDescription

id*

String

Id of an app within organization

Request Body

NameTypeDescription

name*

String(2048)

Consent name

code

String(32)

Short code, can have any value

type

String(32)

Consent type, can have any value

consent_body

String(2048)

Consent content

description

String(2048)

Consent description

{
    "id": "396326ec-2447-648h-b297-da0a81b57b50",
    "name": "Marketing consent",
    "code": "MKT",
    "type": "Marketing",
    "consent_body": "I would like to receive the newsletter",
    "description": "Promotional mobile messages"
}

PUT https://app.bookboost.io/api/v2/partners/resources/app/{app_id}/consents/{id}

At least one of body params are required

Path Parameters

NameTypeDescription

app_id*

String

Id of an app within organization

id*

String

Consent ID

Headers

NameTypeDescription

Authorization*

String

Organization API key

Request Body

NameTypeDescription

name

String(2048)

Consent name

code

String(32)

Short code, can have any value

type

String(32)

Consent type, can have any value

consent_body

String(2048)

Consent content

description

String(2048)

Consent description

{
    "id": "396326ec-2447-648h-b297-da0a81b57b50",
    "name": "Marketing consent",
    "code": "MKT",
    "type": "Marketing",
    "consent_body": "I would like to receive the newsletter",
    "description": "Promotional mobile messages"
}

DELETE https://app.bookboost.io/api/v2/partners/resources/app/{app_id}/consents/{id}

Path Parameters

NameTypeDescription

app_id*

String

ID of an app within organization

id*

String

Consent ID

{
    // Response
}

Last updated