Patch task

patch https://{host}/rest/v1/{agencyId}/tasks

Patches task and returns saved task ID and registration number

Log in to see full request history

Path Params

agencyId

string

required

Query Params

id

int64

ID of document

number

string

Registration number of document

Body Params

id

int64

version

int64

isDisabled

boolean

isDraft

boolean

authorId

int64

number

string

Job Registration Number (optional)

type

string

Type of Job created (Type MUST match Teamogy configuration)

binderId

int64

ID of the Binder in which the Job will be included (optional)

ownerId

int64

ID of the User who is the Owner of the Document

ownerName

string

Name of the User who is the Owner of the Document

assigneeId

int64

assigneeName

string

reporterId

int64

reporterName

string

participantIds

array of int64s

participantIds

category

string

Job Category (optional, Category MUST match Teamogy configuration)

name

string

status

string

Job Status (optional, Status MUST match Teamogy configuration)

statusDate

date

Date of Job Status (optional)

tags

array of strings

Array of Job Tags (optional)

tags

startDate

date

startTime

string

endDate

date

endTime

string

allocation

int32

agencyId

integer

ID of the Business Unit to which the Job belongs (optional, if not defined, agencyId from URL will be used)

jobItemId

int64

jobId

int64

target

string

targetName

string

targetType

string

targetNumber

string

jobNumber

string

jobName

string

jobCompanyName

string

jobBrandName

string

jobBrandLogo

string

jobOwnerId

int64

jobStatus

string

properties

object

Another Job properties (optional fields, field names and value types MUST match Teamogy configuration)

readOnly

boolean

acl

object

Document Access Controll List (optional, manually added above the Default Access Controll List). Final ACL is the merge of Manually attached and Default Access rights

attach

array of strings

Array of attachment links

attach

Headers

host

string

required

Specific domain your company have registered. For example 'yourcompany.teamogy.com'

Response

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://host/rest/v1/agencyId/tasks \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json