POST crm/optout

Unsubscribe for Salesforce user.

Request Information

Parameters

NameDescription
json
  • communication_data [ Mandatory , object ]
    Delete communication types in salesforce user's information
  • ID [ Mandatory , string ]
    Salesforce id

Request body formats

application/json, text/json, text/plain, application/x-www-form-urlencoded

Sample:

{
  "communication_data": [{
      "ID": "0032000001Gm666",
      },{
      "ID": "00320000011x111",
    }]
}

Response Information

Response body formats

application/json, text/json

Sample:

{
  "status": true,
  "receipt": "All records modified.",
  "auditID": "1444",
  "details":[{
    "ID": "0032000001Gm666",
    "status": true,
  },{
    "ID": "00320000011x111",
    "status": true,
  }],
  "items_failed": 0
}
Or Bad Response:
{
  "status": false,
  "receipt": "One or more items were not modified.",
  "auditID": "1445",
  "details":[{
    "ID": "0032000001Gm666",
    "status": false,
  },{
    "ID": "00320000011x111",
    "status": true,
  }],
  "items_failed": 1
}