Delete a contact
Remove a contact you added in error.
delete
/api/public/v1/contacts/{id} Headers
| Header | Value | Why |
|---|---|---|
| X-AUTH-TOKEN | obl_live_... | Your API key. Every call needs one. |
Parameters
| Name | In | What it does |
|---|---|---|
| id required | path | Contact identifier |
The call
curl -X DELETE https://app.obraledger.com/api/public/v1/contacts/... \
-H "X-AUTH-TOKEN: obl_live_..."Want to fill this in and run it? Open it in the playground.
What comes back
A 204 with no body. There is
nothing left to describe, which is the point.
When it fails
Match on the type in the body, not on
the status. A 403 covers both "this key can't do that" and "this record won't allow it", and the
number alone can't tell you which.
- 401 Authentication failed — the `X-AUTH-TOKEN` header is missing, malformed, revoked, or belongs to a different company. Not retryable: the same token will fail identically.
- 403 Authenticated, but not allowed to do this.
- 404 No such record, for the company this key is bound to.
- 429 Rate limit exceeded for this API key. `Retry-After` says how many seconds to wait; `X-RateLimit-Limit` and `X-RateLimit-Remaining` report the budget on every response, not just this one.
The rest of contacts
- get List contacts /api/public/v1/contacts
- get Get one contact /api/public/v1/contacts/{id}
- post Create a contact /api/public/v1/contacts
- patch Update a contact /api/public/v1/contacts/{id}
Base URL https://app.obraledger.com. This page is
generated from the contract the product publishes.
Building something and stuck? Tell us - we'd rather hear it than have you guess.