Marketing Permissions Object v2

Path Parameters

HTTP Header

api-key status:REQUIRED
string - Your Accelerate API Key

URL Substitution

subdomain status:Required
string - Your Accelerate subdomain

relationship ID status:REQUIRED
integer - ID of your chosen relationship

Marketing Permissions Requests status:GEt status:Post

status:Get status:Post - Return all unrevoked marketing permissions for the given relationship

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

Example Payload status:POSt

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

Response

status:200
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"
        }
    ]
}

status:400
Returned if the request sent is invalid.

status:404
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.

QV Systems Knowledge Base