Skip to main content
POST
Creates an agreement

Authorizations

Authorization
string
header
required

Bearer token authentication

Headers

Authorization
string
required
Idempotency-Key
string

Optional client-chosen key, 1 to 255 characters with at least one that is not whitespace; a blank key answers 422. A retry of the same request with the same key from the same company answers with the record the first request created instead of creating another, even when the first response was lost. The same key sent with a different request, or by a different user or credential, answers 422.

Required string length: 1 - 255
Pattern: \S

Query Parameters

language_iso
string

Body

application/json

Request payload

agreement
object | null

Response

string | number | boolean | null | any[] | object

Created, or the agreement an earlier request with the same Idempotency-Key created

Any valid JSON value for provider, integration, theme, metadata, or other dynamic payloads whose keys are not fixed by the API contract.