Retry a logged integration error

PATCH/v1/api/store/{team_slug}/setting/external_integration/retry_action/{id}

v1InternalOperation ID v1_public_external_integration_retry_action

Internal

Built for YoPrint's own apps, not for integrations. It is listed so the reference is complete; don't build on it, and use the other operations in this section.

Asks YoPrint to retry the step behind one error log entry. The {id} is the log entry's id, not the integration's.

In practice nothing is retried today: no log entry is marked retryable, so the call succeeds without doing anything (200, data: null). QuickBooks entries are refused.

Permission

Needs the Manage Settings permission. The team owner always has it.

Path parameters

• team_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team
• idstringrequired

  The error log entry (not the integration), from the integration's error log. Its hash id from an earlier answer; there is no unique key for it.

  • Example i91i7ESuTjjC9i

Request body

This operation takes no request body.

Response

200Successful response.

• datanullrequired
• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.

  When

  Your role lacks Manage Settings. The body is {"message": "Insufficient Permission"}, without the error envelope.

  Fix

  Use the key of a member whose role has Manage Settings, or the owner's.

• 404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.

  When

  No log entry of your team has this id. error.code is null; error.message names the record type.

  Fix

  Use an id from the error log.

• 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

  When

  The entry's integration is not in your plan (plan_limitation).

  Fix

  Upgrade the plan.

• 500A business rule refused the request (see the operation's errors), or something failed inside YoPrint. Refusals use the error envelope with a code such as action_not_allowed; an unexpected failure answers {"message": "Server Error"}. Repeating a refusal gets the same answer; after an unexpected failure, read the record back before you retry a change.

  When

  The entry belongs to QuickBooks Online: error.code cannot retry for quickbook.

  Fix

  Fix the cause in QuickBooks or YoPrint and sync again.

Notes

• AI apps (MCP connections) can't call this operation: they get 403 agent_operation_not_available. Use a personal API key.

Related

• GETList an integration's error log/v1/api/store/{team_slug}/setting/external_integration/{id}/logs

Example request

curl

curl -X PATCH 'https://secure.yoprint.com/v1/api/store/your-team/setting/external_integration/retry_action/i91i7ESuTjjC9i' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1'

Example response 200

Response

{
  "data": null,
  "status": 200,
  "success": true
}