Create an approval request

POST

/approval_requests

Headers

Auth

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-monite-versionstringRequired

x-monite-entity-idstringRequired

The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.

Approval Request Create by Role Requestobject

Approval Request Create by User Requestobject

Response

Successful Response

idstringformat: "uuid"

created_atdatetime

updated_atdatetime

approved_bylist of strings

created_bystringformat: "uuid"

ID of the user who created the approval request

object_idstringformat: "uuid"

object_typeenum

required_approval_countinteger>=1

role_idslist of strings

statusenum

Allowed values: waitingapprovedrejectedcanceled

user_idslist of strings

rejected_bystringOptionalformat: "uuid"

Errors

POST

1 curl -X POST https://api.sandbox.monite.com/v1/approval_requests \
2      -H "x-monite-version: 2024-05-25" \
3      -H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4      -H "Authorization: Bearer <token>" \
5      -H "Content-Type: application/json" \
6      -d '{
7   "object_id": "object_id",
8   "object_type": "account",
9   "required_approval_count": 1,
10   "role_ids": [
11     "role_ids"
12   ]
13 }'

1 {
2   "id": "id",
3   "created_at": "2024-01-15T09:30:00Z",
4   "updated_at": "2024-01-15T09:30:00Z",
5   "approved_by": [
6     "approved_by"
7   ],
8   "created_by": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
9   "object_id": "object_id",
10   "object_type": "account",
11   "required_approval_count": 1,
12   "role_ids": [
13     "role_ids"
14   ],
15   "status": "waiting",
16   "user_ids": [
17     "user_ids"
18   ],
19   "rejected_by": "rejected_by"
20 }

Get an approval request by ID

Up Next

1	curl -X POST https://api.sandbox.monite.com/v1/approval_requests \
2	-H "x-monite-version: 2024-05-25" \
3	-H "x-monite-entity-id: 9d2b4c8f-2087-4738-ba91-7359683c49a4" \
4	-H "Authorization: Bearer <token>" \
5	-H "Content-Type: application/json" \
6	-d '{
7	"object_id": "object_id",
8	"object_type": "account",
9	"required_approval_count": 1,
10	"role_ids": [
11	"role_ids"
12	]
13	}'

1	{
2	"id": "id",
3	"created_at": "2024-01-15T09:30:00Z",
4	"updated_at": "2024-01-15T09:30:00Z",
5	"approved_by": [
6	"approved_by"
7	],
8	"created_by": "ea837e28-509b-4b6a-a600-d54b6aa0b1f5",
9	"object_id": "object_id",
10	"object_type": "account",
11	"required_approval_count": 1,
12	"role_ids": [
13	"role_ids"
14	],
15	"status": "waiting",
16	"user_ids": [
17	"user_ids"
18	],
19	"rejected_by": "rejected_by"
20	}