Puts a contact on stop

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

Path Parameters

contactId int64 required

Contact id

Header Parameters

Customer-Id int64 required

The customer identifier

application/json

Request Body

Model representing stop contact operation

appliesTo StopAppliesTo

Possible values: [contactOnly, contactAndChildren]

Indicates if the contact's child contacts should also be on stop

Possible values:

• contactOnly: Contact only
• contactAndChildren: Contact and children

status StopStatus

Possible values: [contactOnStop, creditLimitOnStop]

Indicates whether the contact should be put on stop or their credit limit

Possible values:

• contactOnStop: Contact on stop
• creditLimitOnStop: Credit limit on stop

stopReason string

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

Responses

• 204
• 400
• 403
• 404
• 422
• 500

---

No Content

Bad Request

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Forbidden

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Not Found

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Client Error

application/problem+json

Schema

Example (from schema)

---

Schema

errors object
property name* string[]
Array [
string
]
type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "errors": {},
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Server Error

application/problem+json

Schema

Example (from schema)

---

Schema

type string nullable

A URI reference [RFC3986] that identifies the problem type

title string nullable

A short, human-readable summary of the problem type

status int32 nullable

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem

detail string nullable

A human-readable explanation specific to this occurrence of the problem

instance string nullable

A URI reference that identifies the specific occurrence of the problem

{
  "type": "https://example.com/probs/out-of-credit",
  "title": "You do not have enough credit",
  "status": 403,
  "detail": "Your current balance is 30, but that costs 50",
  "instance": "/account/12345/msgs/abc"
}

Loading...