Skip to content

Validate or rotate the plugin credential

POST /token/sync

Reference path for manifest tokenSyncUrl, required when isAsync is true. Before each asynchronous call, SMS, or fax dispatch, App Connect POSTs an empty JSON object with the stored plugin bearer. The response body is ignored. Return a replacement credential in X-Refreshed-JWT-Token when rotation is required; App Connect uses it for the immediately following invocation and persists it after dispatch. Refresh headers from the asynchronous invocation are ignored. A callback-enabled call token-sync failure marks the task failed without rolling back the already-saved CRM activity; SMS and fax logging continues after a failed fire-and-forget dispatch.

Operation ID: syncPluginToken
Authorization: BEARER

Request body

App Connect sends an empty JSON object when synchronizing the plugin credential.

Required: Yes

Content type: application/json

Schema: EmptyObject

{}

Responses

Status Description Body
200 The credential was accepted. The body is ignored; the template returns OK. An optional X-Refreshed-JWT-Token rotates the credential. HealthResponse
401 The plugin bearer credential is missing or invalid. TextError
403 The credential is valid but is not authorized for the requested account or plugin. The template's plugin-id comparison works only after the route or trusted configuration supplies a plugin identifier; its documented paths do not contain :pluginId. TextError
500 The plugin server could not validate or rotate the credential. TextError