Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Contacts

Puts a contact on stop

Puts business dealings with a contact on stop, usually because they have outstanding payments. (required scope contacts:write)

put/v1/contacts/{contactId}/stop

Path parameters

contactIdinteger required

Contact id

Headers

Customer-Idinteger required

The customer identifier

Request body

appliesTo'contactOnly' | 'contactAndChildren'

Indicates if the contact's child contacts should also be on stop<p>Possible values:</p><ul><li><b>contactOnly</b>: Contact only</li><li><b>contactAndChildren</b>: Contact and children</li></ul>

status'contactOnStop' | 'creditLimitOnStop'

Indicates whether the contact should be put on stop or their credit limit<p>Possible values:</p><ul><li><b>contactOnStop</b>: Contact on stop</li><li><b>creditLimitOnStop</b>: Credit limit on stop</li></ul>

stopReasonstring

The textual description of why the contact has been put on stop

Example request

{
  "appliesTo": "contactOnly",
  "status": "contactOnStop",
  "stopReason": "This customer has not paid for our services and won't return calls."
}

Response

No Content