Skip to main content

Marketing Permissions Object v2

A technical guide to retrieving and updating marketing permissions for relationships in Accelerate using API v2.

Funmilola Olorode avatar
Written by Funmilola Olorode
Updated over 6 months ago

Path Parameters

HTTP Header

api-key REQUIRED

string - Your Accelerate API Key

URL Substitution

subdomain REQUIRED
string - Your Accelerate subdomain

relationship ID REQUIRED
integer - ID of your chosen relationship


Marketing Permissions Requests

GET POST

GET POST - Return all unrevoked marketing permissions for the given relationship

https://{{subdomain}}.quotevineapp.com/qvine/quotevine/api/v2/relationships/{id}/marketing-permissions/


Example Payload

POST

{
"email":"Y",
"fax":"N",
"sms":"Y",
}

Response

400

Returned if the request sent is invalid.

404

Returned if the request is not found or the user does not have permission to view it.

200
Returned if the request is successful.

Expand to see example of a successful response.

{
"items": [
{
"marketing_medium": "Email",
"granted_date": "2022-08-03T08:47:59.936Z"
},
{
"marketing_medium": "Post",
"granted_date": "2022-08-03T08:48:01.887Z"
},
{
"marketing_medium": "Telephone",
"granted_date": "2022-08-03T08:48:03.772Z"
}
]
}

Marketing Permissions Attributes


When modifying a relationship’s marketing permissions, you need to specify at least one of the following fields:

email - string

fax - string

sms - string

post - string

telephone - string

group - string

All fields are either Y or N.



Did this answer your question?