Update Integration ​
Update an existing integration. This call supports updating config, category, beta status, and sharing policy. A version mismatch (optimistic concurrency) will cause a 400 Bad Request
error.
Endpoint ​
PATCH /integrations/{id}
Path parameters ​
The ID of the integration to update.
4a4de828-f4db-4c9e-adfd-434e0864c3c7
Request Body ​
The name of your integration.
my_custom_crm
A short descriptor or category.
crm
The updated configuration object for the integration.
Whether the integration is considered beta.
The current version of the integration. Required for concurrency control.
3
Response Body ​
The ID of the integration.
4a4de828-f4db-4c9e-adfd-434e0864c3c7
The name of the integration.
zendesk
The category of the integration.
helpdesk
Whether the integration is in beta or not. Beta integrations might not have been tested completely and are not recommended for production environments.
The configuration object defining the underlying API of the integration.
{
"base_url": "https://api.example.com",
"label": "Example API",
"logo": "https://example.com/logo.png",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"User-Agent": "truto"
},
"authorization": {
"format": "bearer",
"config": {
"value": "{{oauth.token.access_token}}"
}
},
"pagination": {
"format": "page",
"config": {
"page_key": "page",
"limit_key": "per_page"
}
},
"resources": {
"users": {
"list": {
"method": "get",
"path": "/users",
"response_path": "data.users"
}
}
}
}
The ID of the team that owns this integration.
05daecaf-4365-42e8-8370-8127de5dd717
The sharing policy of the integration.
allow
ask
deny
allow
The date and time when the integration was created.
2021-08-10T10:00:00.000Z
The date and time when the integration was last updated.
2021-08-10T10:00:00.000Z
A list of environment IDs where this integration is installed.
The team that owns this integration.
The ID of the team.
05daecaf-4365-42e8-8370-8127de5dd717
The name of the team.
My Awesome Team
The domain of the team.
example.com
The URL of the team's logo.
https://example.com/logo.png
Whether the team is verified or not.
true
Whether the team is white-labeled or not.
A link to the team's Terms of Service, if available.
https://example.com/tos
Whether the team allows impersonation.
The date and time when the team was created.
2021-08-10T10:00:00.000Z
The date and time when the team was last updated.
2021-08-10T10:00:00.000Z