PUT /agreements/{id}.json

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

application/json

Body Required

createdAt string(date-time)

Created at
files object | array | boolean | integer | number | string Required

Files

Any of:
object-1 object array-2 array boolean-3 boolean integer-4 integer number-5 number string-6 string
filesRequired boolean | null Required

Files required

Default value is false.
id integer(int32)

Id
instructions string | null

Instructions
name string Required

Name
status string | null Required

Status

Values are draft, active, or archived. Default value is draft.
updatedAt string(date-time)

Updated at

curl \
 --request PUT 'http://api.example.com/v1/agreements/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"createdAt":"2025-05-04T09:42:00Z","files":{},"filesRequired":false,"id":42,"instructions":"string","name":"string","status":"draft","updatedAt":"2025-05-04T09:42:00Z"}'

Request examples

{
  "createdAt": "2025-05-04T09:42:00Z",
  "files": {},
  "filesRequired": false,
  "id": 42,
  "instructions": "string",
  "name": "string",
  "status": "draft",
  "updatedAt": "2025-05-04T09:42:00Z"
}

Path parameters

Body Required

files object | array | boolean | integer | number | string Required