Skip to main content
POST
Asks contacts to approve something on a task.

Authorizations

X-API-Key
string
header
required

Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.

Path Parameters

projectId
string<uuid>
required

Project the task belongs to.

taskId
string<uuid>
required

Task the approval is for.

Body

What is being approved, and by whom.

Request body for asking contacts to approve something on a task.

Name
string
required

What is being approved. Required.

Minimum string length: 1
ContactIds
integer<int64>[]

Contacts asked to approve. Required. Each must be an active contact of the task's client and carry a contact tag marked as an approver.

Response

OK

StatusCode
enum<integer>
Available options:
100,
101,
102,
103,
200,
201,
202,
203,
204,
205,
206,
207,
208,
226,
300,
301,
302,
303,
304,
305,
306,
307,
308,
400,
401,
402,
403,
404,
405,
406,
407,
408,
409,
410,
411,
412,
413,
414,
415,
416,
417,
421,
422,
423,
424,
426,
428,
429,
431,
451,
500,
501,
502,
503,
504,
505,
506,
507,
508,
510,
511
IsSuccess
boolean
Data
object

The identifier of the created approval.

DataContext
object | null
Example:

null

Notifications
object[]