Update Integration Account

Updates an existing integration account within a workspace.

HTTP Request

POST https://dev.calry.app/api/v1/integration_account/{integrationAccountId}

Headers

Header	Value
Authorization	Bearer YOUR_ACCESS_TOKEN

Path Parameters

Parameter	Required	Type	Description
integrationAccountId	Yes	string	The unique identifier for the integration account.

Request Body

The request body should be a JSON object containing the following fields:

Field	Required	Type	Description
syncEnabled	No	boolean	Indicates if the account is enabled for sync.
syncPeriod	No	SYNC_PERIOD	Indicates the sync period for the account.

Enum

Value	Description
EVERY_HOUR	Sync every hour
EVERY_TWO_HOURS	Sync every two hours
EVERY_THREE_HOURS	Sync every three hours
EVERY_FOUR_HOURS	Sync every four hours
EVERY_FIVE_HOURS	Sync every five hours
EVERY_SIX_HOURS	Sync every six hours
EVERY_HALF_DAY	Sync every half day
EVERY_DAY	Sync every day
EVERY_TWO_DAYS	Sync every two days

Example Request

curl --location 'https://dev.calry.app/api/v1/integration_account/6345e1f5-2613-48c6-9459-2fedda67a821' \
--header 'Authorization: Bearer eyJraWQiOiJzLTg3NmRmNzQ3LTdiNzYtNGRiZi1hN2MyLTY1NWIxMTMzNWYzNiIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjMwMDAvYXV0aCIsInVzZXJJZCI6IjZlNmVkNmM5LTQxMjMtNDIyZi05ODZlLTgzMWFkODZjNzlkYSIsIndvcmtzcGFjZUlkIjoiMTM3Yzc1NDItYTJmNC00MWI3LWI3MWYtMDVjMGU5ZDNjODE5IiwibmFtZSI6ImFzZGFzZCIsInNvdXJjZSI6Im1padJvc2VydmljZSIsImlhdCI6MTcxNjU3Nzc5OCwiZXhwIjoxNzI4Njk5MDEwfQ.fn_dmhBlDwu8gDvwlPYUmZC3ZbKPTxpwBw0nDkaXBwBMOoF1JxJIHNJ-rMsXrX-NdTq3yaK-rC7c_MZlW_n_dZlsv2zLrDTknBM_HOUyMheyv_r7e6judhv7DsuC6adB8Pn7rNqpGVLbFH7yA8ktxpBFvLKNAi6ncIE27qH3mcVcrCIsS3fjsS3zK3SLhhuBdTnFaVZf3LFR3XbUVQdQz2JX-YsWgy6O2TJQdnDCdWyIhkeignxK3sxNb_2CxcT_yri9Vqx3gM_GgNuesV0hX1QTHYrxcpkd8uQVTnhBtUmYKfXAipT0Hw0hVifeJj209R9bCuXj0yQVNCFR5zP4HQ' \
--header 'Content-Type: application/json' \
--data '{
    "syncEnabled": true,
    "syncPeriod": "EVERY_HOUR"
}'

Response

The response is a JSON object containing the following properties:

• integrationAccountId (string): A unique identifier for the Integration Account.
• integrationDefinitionId (string): A unique identifier for the Integration Definition.
• workspaceId (string): A unique identifier for the Workspace.
• integrationAccountName (string): A name for the account to be displayed in the UI.
• deleted (string|null): Indicates if the account is deleted.
• createdAt (string): Timestamp of when the integration account was created.
• updatedAt (string): Timestamp of when the integration account was last updated.
• accountIdentifier (string|null): Identifier for the account.
• syncEnabled (boolean): Indicates if the account is enabled for sync.
• syncPeriod (string): Indicates the sync period for the account.
• linkId (string|null): The identifier of the link used to create this account.
• integrationDefinition (object): The integration definition associated with this account.

Example Response

{
    "integrationAccountId": "18404352-8c25-4a34-a0b9-1faaee53bacc",
    "integrationDefinitionId": "1c579b3e-2e49-4b13-bafb-227cd9116add",
    "workspaceId": "0340a5ee-426b-4bdc-91ac-7a3150a03e47",
    "integrationAccountName": "Calry Link_rv2bo",
    "deleted": null,
    "createdAt": "2024-01-25T20:11:50.826Z",
    "updatedAt": "2024-01-25T20:11:50.826Z",
    "accountIdentifier": "12345",
    "syncEnabled": true,
    "syncPeriod": "EVERY_HOUR",
    "linkId": "593fd71b-101a-4094-9d05-b53781d3f3fe",
    "integrationDefinition": {
        "integrationDefinitionId": "1c579b3e-2e49-4b13-bafb-227cd9116add",
        "name": "Hostaway",
        "key": "hostaway",
        "icon": "hostaway.svg",
        "integrationType": "VRS"
    }
}

Response Codes

• 200 OK: The integration account information was successfully retrieved.
• 400 Bad Request: The request was invalid or the integrationAccountId was not provided.
• 401 Unauthorized: The request lacks valid authentication credentials.