Consents

Table of contents¶

• Introduction
• Use cases
• Available methods
• Parameter table
• Examples

Introduction¶

This article covers the API requests related to the mandatory consents under data protection regulations (GDPR), and how to manage them on contacts.

• Create consents for a contact
• List and filter consents for one or more contacts

A consent is understood as: a granted permission, accepted terms or communications, or other similar concepts, where the guest decides whether to authorize the company to send them communications.

Fideltour supports the following consents:

• Terms and conditions (T)
• Marketing communications (C)
• Personalized marketing communications (P)
• WhatsApp marketing communications (WC)
• WhatsApp enabled (WE)
• SMS marketing communications (SC)

Endpoint: https://app.hoteldatahub.io/api/v1/consents/

Swagger documentation: https://app.hoteldatahub.io/swagger/#/consents

Use cases¶

This endpoint is necessary to comply with GDPR and to manage the different types of consent for contacts in Fideltour. The consent management endpoint requires contacts to already exist, and lets you query and add new consents to your contacts.

Important: A consent is always associated with a contact.

It's important to comply with GDPR, so whenever you have the information or data indicating whether a contact has accepted or declined one of the consents listed above, you should add the appropriate consent to the contact.

This way, you ensure that the customer stays GDPR-compliant while using Fideltour, and that communications aren't sent to contacts who haven't authorized them.

Available methods¶

All the methods and filters available for working with contacts can be found in the Swagger documentation. This article focuses on the following:

• GET: Retrieve data for one or more consents
• POST: Create a new consent

Parameter table¶

Examples¶

Below are some examples of creating and listing consents.

Request (POST): Create a consent¶

Create a consent for a Fideltour contact

PROTOCOL: HTTP/1.1 METHOD: POST HOST/ENDPOINT: https://app.hoteldatahub.io/api/v1/consents/

HEADERS:

Content-type: application/json
Authorization: Token xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

BODY:

{
    "contact": 11602828,
    "subscription_type": "C",
    "change_type": 1,
    "source": 1
}

Response:

For a 201 response, you receive the following JSON:

{
    "id": 6069294,
    "timestamp": "2023-11-13T13:29:15.469910",
    "change_type": 0,
    "subscription_type": "C",
    "unsubscribe_reason": null,
    "source": 0,
    "ip": null,
    "opt_in": "S",
    "doble_opt_in_timestamp": null,
    "doble_opt_in_ip": null,
    "contact": 11602828
}

Request (GET): List a contact's consents¶

List a contact's consents

PROTOCOL: HTTP/1.1 METHOD: GET HOST/ENDPOINT: https://app.hoteldatahub.io/api/v1/consents/?contact=11602828

HEADERS:

Content-type: application/json
Authorization: Token xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

QUERY: The contact's ID must be sent via query string, using the contact attribute

Response:

For a 200 response, you receive the following JSON:

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 6069294,
            "timestamp": "2023-11-13T13:29:15.469910",
            "change_type": 0,
            "subscription_type": "C",
            "unsubscribe_reason": null,
            "source": 0,
            "ip": null,
            "opt_in": "S",
            "doble_opt_in_timestamp": null,
            "doble_opt_in_ip": null,
            "contact": 11602828
        }
    ]
}

Request (GET): Get a consent by ID¶

Get a consent by its ID

PROTOCOL: HTTP/1.1 METHOD: GET HOST/ENDPOINT: https://app.hoteldatahub.io/api/v1/consents/<consent_id>/

HEADERS:

Content-type: application/json
Authorization: Token xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Response:

For a 200 response, you receive the following JSON:

{
    "id": 6069294,
    "timestamp": "2023-11-13T13:29:15.469910",
    "change_type": 0,
    "subscription_type": "C",
    "unsubscribe_reason": null,
    "source": 0,
    "ip": null,
    "opt_in": "S",
    "doble_opt_in_timestamp": null,
    "doble_opt_in_ip": null,
    "contact": 11602828
}