Prepare a mutation

Prepare a mutation with {input: {…}}. Preparation does not approve or execute publication. A successful preparation returns confirmationCapability and expiresAt; a tool failure can still use HTTP 200. JSON requests are limited to 65,536 bytes.

POST/api/v1/tools/{tool}/prepare

Authorization

AuthorizationBearer token · headerrequired

Influence scoped API key or supported OAuth access token. Keep credentials out of URLs and tool input.

Path parameters

toolstringrequired

Tool name returned by GET /api/v1/tools. Discovery is filtered by this credential's permissions; schema presence does not establish availability.

Request body

requiredapplication/json

inputobjectrequired

Responses

200

Preparation or tool failure.

Any of:

PreparedTool

confirmationCapabilitystringrequired

Return this value in the X-Publish-Confirmation header before expiresAt.

min length 32 · max length 4096 · matches ^[A-Za-z0-9._~-]+$

expiresAtstring<date-time>required

matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$

inputDigeststringrequired

matches ^[0-9a-f]{64}$

statusstringrequired

summary__schema0

Show properties

__schema0

toolNamestringrequired

Allowed:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListwhatsappContactListwhatsappTemplateListwhatsappMediaListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsToolgenerateVideoOptionsvideoFunctionToolgenerateVideoToolgenerateImageTooluploadFromUrlTool

ToolError

errorobjectrequired

Show properties

codestringrequired

Allowed:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringrequired

min length 1 · max length 2048

retryablebooleanrequired

okbooleanrequired

toolNamestringrequired

400

Invalid request. Query parameters are not accepted. Tool validation failures may use a tool error envelope.

Any of:

TransportError

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

ToolError

errorobjectrequired

Show properties

codestringrequired

Allowed:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringrequired

min length 1 · max length 2048

retryablebooleanrequired

okbooleanrequired

toolNamestringrequired

401

Missing, invalid or expired bearer credential.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

403

The credential lacks required permissions.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

404

The machine API or requested tool is unavailable.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

413

The request exceeds the byte limit.

errorobjectrequired

Show properties

codestringrequired

Allowed:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringrequired

min length 1 · max length 2048

retryablebooleanrequired

okbooleanrequired

toolNamestringrequired

429

Rate limit exceeded. The error is retryable.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

503

The API or its upstream execution is unavailable.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

Request

curl -X POST 'https://influence.so/api/v1/tools/string/prepare' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "input": {
    "property1": "string",
    "property2": "string"
  }
}'

const response = await fetch("https://influence.so/api/v1/tools/string/prepare", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"input\": {\n    \"property1\": \"string\",\n    \"property2\": \"string\"\n  }\n}"
});

import requests

response = requests.post(
    "https://influence.so/api/v1/tools/string/prepare",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"input\": {\n    \"property1\": \"string\",\n    \"property2\": \"string\"\n  }\n}",
)

Response

{
  "confirmationCapability": "stringstringstringstringstringst",
  "expiresAt": "2019-08-24T14:15:22Z",
  "inputDigest": "string",
  "status": "confirmation_required",
  "summary": "string",
  "toolName": "adAuditQuote"
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true
  }
}

{
  "error": {
    "code": "INVALID_INPUT",
    "message": "string",
    "retryable": true
  },
  "ok": false,
  "toolName": "adAuditQuote"
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true
  }
}