Docs

Type a word or a question. Esc closes the search.

Sign in Start free

Archive a client

Returns a confirmation message after archiving a Client.

POST https://app.upfour.io/v1/clients/{clientID}/archive
POST https://app.upfour.io/v1/clients/{clientID}/archive

A real request. Sending it changes data in your up4 account.

Authorization
AuthorizationA pls_ key. It stays in this browser tab. Needs client.write.
Path
Headers

Sent directly from your browser to https://app.upfour.io/v1. Mutating calls get an automatic Idempotency-Key when the field is empty.

Request
Responsenot sent yet
Fill in a key and press Send request (⌘↵).
The answer appears here.
scope client.write stable Idempotency-Key supported returns 200

Parameters

FieldTypeDescription
clientID required uuid path parameter

Returns

A successful request returns 200 with application/json.

Response fields 1 top-level fields
FieldTypeDescription
data ClientMessageResponse
ClientMessageResponse · 1 fields
FieldTypeDescription
message string

Errors

Only the errors this operation can return. Every error uses the same envelope.

Status Code Meaning
400 bad_request The request is malformed or fails validation.
404 not_found The requested resource does not exist or is outside the caller's scope.
403 permission_denied The credentials do not permit this action.

Every call can also return unauthorized (401), rate_limit_exceeded (429) or internal_error (500 / 502). See Responses and errors.