Update onboarding agreement

PUT

/v1/agreements/{agreement_id}

Updates the translation for one language of an existing onboarding agreement, identified by {agreement_id} in the path (not in the body). Partner or admin callers only - merchants cannot update agreements.

Request

Authorization

API Key

Add parameter in header

X-API-KEY

Example:

X-API-KEY: ********************

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Path Params

Body Params application/json

Examples

Responses

🟢200

application/json

Body

🟠400

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT '/v1/agreements/9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d' \
--header 'X-API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "language": "en",
    "title": "Merchant Agreement"
}'

Response Example

200 - response

{
    "data": {
        "id": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",
        "title": {
            "en": "Merchant Agreement"
        },
        "description": {
            "en": "Terms governing the merchant relationship"
        },
        "link": {
            "en": "https://amili.no/legal/merchant-agreement"
        },
        "deactivate": false,
        "status": "pending",
        "created_at": "2026-01-12T08:37:02.000Z",
        "updated_at": "2026-01-12T08:37:02.000Z"
    }
}

Modified at 2026-09-25 07:15:05

Retrieve a single agreement

Deactivate agreement