Server
Privacy & Consent: Onboarding / Reference / REST APIs

Manages a user's consent.

POST

Sets a user's required legal consent statuses

manage:consent-hub-consent

Request

Request bodyapplication/json

The update request

consents

array<ConsentRequest>

email

string

Required
formUrl

string

locale

string

Required
providerId

string

Responses

If the validation of request data is successful, the status code will be 202 with no response body. This indicates that the request has been accepted for processing. All update operations are asynchronous and may take several seconds to take effect.

POST/consent
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 curl --request POST \ --url 'https://api.atlassian.com/consent-hub/consent' \ --user 'email@example.com:<api_token>' \ --header 'Content-Type: application/json' \ --data '{ "consents": [ { "displayedText": "Yes, I would like to receive promotional emails including product news, events, and more from Atlassian and its affiliates.\n", "granted": true, "key": "generalMarketingOptIn" } ], "email": "example@email.com", "formUrl": "<string>", "locale": "US", "providerId": "12345" }'
POST

Retrieves user consent and locale information by IP address and user email

manage:consent-hub-consent

Request

Request bodyapplication/json

User's email and IP address

email

string

userIp

string

Responses

The configuration information was retrieved

application/json

ConsentConfiguration
POST/consent-config/get
1 2 3 4 5 6 7 8 9 curl --request POST \ --url 'https://api.atlassian.com/consent-hub/consent-config/get' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "email": "example@email.com", "userIp": "185.166.140.232" }'
200Response
1 2 3 4 5 6 { "locale": "US", "localeRequiresMarketingCommunicationOptIn": true, "hasUserMadeChoiceOnMarketingCommunicationOptIn": true, "usersChoiceOnMarketingCommunicationOptIn": true }

Rate this page: