Path Parameters

HTTP Header

api-key
string - Your Accelerate API Key

URL Substitution

subdomain
string - Your Accelerate subdomain

relationship ID
integer - ID of your chosen relationship


Marketing Permissions Requests

- Return all unrevoked marketing permissions for the given relationship

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

Example Payload

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

Response


Returned if the request is successful.

{
    "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"
        }
    ]
}


Returned if the request sent is invalid.


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


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.