---
title: "Puts a contact on stop"
method: PUT
path: "/v1/contacts/{contactId}/stop"
tags: ["Contacts"]
---

# Puts a contact on stop

`PUT /v1/contacts/{contactId}/stop`

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

## Path parameters

- `contactId` integer, required

## Headers

- `Customer-Id` integer, required

## Request body

- StopContactModel — Represents a model that holds information about putting a contact on stop
  - `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>
  - `stopReason` string — The textual description of why the contact has been put on stop

## Response `204`

No Content

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `422` — Unprocessable Content
- `500` — Internal Server Error

---

[API](https://skmtc.net/bigchange/apis/bigchange-dx.md) · [All operations](https://skmtc.net/bigchange/apis/bigchange-dx/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bigchange/bigchange-dx/revisions/916e669fc527/schema)