Skip to content

Accepting Consent

Variables - Details

Name Description Required
salesJourneyId sales journey id that was received when sales session is initialized Required

API Specs

GraphQL API

Ready

This API is available in both integration and production.

HTTP Item HTTP Value
Url https://{host}/graphql
Method POST

 
mutation Mutation($salesJourneyId:String!,$consentId:String!,$acceptanceChannel:String!,$clientIpAddress:String!) {
    presentConsent(salesJourneyId:$salesJourneyId,consentId:$consentId){
        salesJourneyId
        consent {

        consentInfo {
            consentId
            status
        }
    }
}

}

 
{
    "salesJourneyId": "{{ salesJourneyId }}"
}

None

None

 
{
    "data": {
        "acceptConsent": {
            "salesJourneyId": "20eaf0fd-800e-47b0-bff7-5a0c6675b01f",
            "consent": {
                "consentInfo": {
                    "consentId": "3405d6b6-f1f6-46d8-9225-48ce83690731",
                    "status": "ACCEPTED"
                }
            }
        }
    }
}

 
{
    "errors" : []
}

Coming soon

REST API

Warning

This API is in development.

HTTP Item HTTP Value
Url https://{host}/{salesJourneyId}/consent/action/accept
Method PUT

None

Param Name Description Required
salesJourneyId The id you got from init step Required

 
{
    "salesJourneyId": "string",
    "consent": {
        "consentInfo": {
        "consentId": "string",
        "status": "string"
        },
        "items": [
        {
            "offerId": "string",
            "chargeDetails": [
            {
                "currency": "string",
                "charges": 0,
                "chargeType": "string",
                "chargeFrequency": "string",
                "duration": 0
            }
            ],
            "metadata": [
            {
                "name": "string",
                "value": "string"
            }
            ],
            "presentationContents": [
            {
                "name": "string",
                "content": "string"
            }
            ],
            "termsOfServices": [
            {
                "items": [
                {
                    "id": "string",
                    "description": "string"
                }
                ]
            }
            ]
        }
        ]
    }
}

 
{
    "errorCode" :  "",
    "errorMessage" : "",
    "severity" : ""
}

Coming soon