Update sync job cron trigger ​
You can use this endpoint to update a sync job cron trigger by it's ID.
Endpoint ​
PATCH /sync-job-cron-trigger/{id}
Path parameters ​
The ID of the sync job cron trigger to update.
1f276317-1c44-4ae8-b2e2-f7b8bc0f6aa5
Request Body ​
The ID of the sync job to run.
1ba1f401-7183-47c5-9e39-e8e257e3c795
The arguments passed to the sync job run.
{
"project_slug": "vcs_provider/org_name/repo_name"
}
The ID of the integrated account that this sync job run belongs to.
94801e49-a652-42f9-af14-dd203d7897da
The name of the daemon group that this sync job run should be assigned to. Used while creating a sync job run. Truto find a daemon in the group that is available to run the sync job. You can either specify daemon_group_key
(Daemon) or webhook_id
(RapidBridge), but NOT both while creating a Sync Job Run.
default
The ID of the webhook where the sync job records need to be sent. You can either specify daemon_group_key
(Daemon) or webhook_id
(RapidBridge), but NOT both while creating a Sync Job Run.
4a4de828-f4db-4c9e-adfd-434e0864c3c7
The cron expression that defines when the sync job should be run. The timezone used is UTC.
0 0 * * *
Response Body ​
The ID of the sync job cron trigger.
4a4de828-f4db-4c9e-adfd-434e0864c3c7
The arguments passed to the sync job cron trigger.
{
"project_slug": "vcs_provider/org_name/repo_name"
}
The resources to sync as part of the sync job.
The name of the resource to sync. For Unified APIs, it should be in the format unified_api_name/resource_name
. For Proxy API, it can just be resource_name
.
For fetching Contacts from CRM Unified API, `crm/contacts`. For fetching Contacts from a Proxy API, `contacts`.
The method to call on the resource.
list
The ID of the resource to sync. This is optional and can be used to sync a single resource. It also supports placeholders.
Static value like `4a4de828-f4db-4c9e-adfd-434e0864c3c7` or placeholder like `{{args.user_id}}`.
The query parameters to pass to the resource method. It supports placeholders for values.
{
"page": 1,
"per_page": 100,
"user_id": "{{args.user_id}}"
}
When a particular placeholder argument is an array and you want to repeat the request for each element in that array, you can set this parameter. For example, if you accept an argument called user_ids
which is an array of strings, and you want to fetch each user's details, you can set this parameter to user_ids
and the request will be repeated for each element in the user_ids
array.
{
"{ args.user_ids }": null
}
The resource that this resource depends on (parent resource). This is optional and can be used to sync a resource only after another resource has been synced. Each object synced for the parent resource is available as the resources object in placeholders for the child resource, e.g. {{resources.crm.contacts.id}}
if depends on is crm/contacts
resource.
crm/contacts
Whether to persist the resource in the database or not in case of a Daemon sync job run or send as a payload in case of RapidBridge sync job run. The Proxy API resources are by default NOT persisted and this parameter can be set to true
to persist them. Unified API resources are always persisted.
The cron expression defining when the sync job should run.
0 0 * * *
The ID of the sync job that this sync job cron trigger should run.
4a4de828-f4db-4c9e-adfd-434e0864c3c7
The ID of the integrated account that this sync job cron trigger should run.
94801e49-a652-42f9-af14-dd203d7897da
The name of the daemon group that this sync job run should be assigned to. Used while creating a sync job run. Truto find a daemon in the group that is available to run the sync job. You can either specify daemon_group_key
(Daemon) or webhook_id
(RapidBridge), but NOT both while creating a Sync Job Run.
default
The ID of the webhook where the sync job records need to be sent. You can either specify daemon_group_key
(Daemon) or webhook_id
(RapidBridge), but NOT both while creating a Sync Job Run.
4a4de828-f4db-4c9e-adfd-434e0864c3c7
The date and time when the sync job run was created.
2021-08-10T10:00:00.000Z
The date and time when the sync job run was last updated.
2021-08-10T10:00:00.000Z