Wijziging voorbereiden

Bereid een wijziging voor met {input: {…}}. Voorbereiden geeft geen goedkeuring voor publicatie en publiceert niets. Bij succes krijg je confirmationCapability en expiresAt terug; ook een toolfout kan HTTP 200 gebruiken. JSON-verzoeken zijn beperkt tot 65536 bytes.

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

Autorisatie

AuthorizationBearer-token · headerverplicht

Influence-API-sleutel met beperkte rechten of ondersteund OAuth-toegangstoken. Zet toegangsgegevens niet in URL’s of toolinvoer.

Padparameters

toolstringverplicht

Toolnaam uit GET /api/v1/tools. De lijst wordt gefilterd op de rechten van je toegangsgegevens; een schema betekent niet dat de tool beschikbaar is.

Verzoekinhoud

verplichtapplication/json

inputobjectverplicht

Antwoorden

200

Voorbereiding of toolfout.

Een of meer van:

PreparedTool

confirmationCapabilitystringverplicht

Stuur deze waarde vóór expiresAt terug in de header X-Publish-Confirmation.

min. lengte: 32 · max. lengte: 4096 · komt overeen met ^[A-Za-z0-9._~-]+$

expiresAtstring<date-time>verplicht

komt overeen met ^(?:(?:\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)))$

inputDigeststringverplicht

komt overeen met ^[0-9a-f]{64}$

statusstringverplicht

summary__schema0

Eigenschappen tonen

__schema0

toolNamestringverplicht

Toegestane waarden:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListwhatsappContactListwhatsappTemplateListwhatsappMediaListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsToolgenerateVideoOptionsvideoFunctionToolgenerateVideoToolgenerateImageTooluploadFromUrlTool

ToolError

errorobjectverplicht

Eigenschappen tonen

codestringverplicht

Toegestane waarden:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringverplicht

min. lengte: 1 · max. lengte: 2048

retryablebooleanverplicht

okbooleanverplicht

toolNamestringverplicht

400

Ongeldig verzoek. Queryparameters zijn niet toegestaan. Validatiefouten kunnen het foutformaat van de tool gebruiken.

Een of meer van:

TransportError

errorobjectverplicht

Eigenschappen tonen

codestringverplicht

messagestringverplicht

retryablebooleanverplicht

ToolError

errorobjectverplicht

Eigenschappen tonen

codestringverplicht

Toegestane waarden:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringverplicht

min. lengte: 1 · max. lengte: 2048

retryablebooleanverplicht

okbooleanverplicht

toolNamestringverplicht

401

Bearer-toegangsgegevens ontbreken, zijn ongeldig of verlopen.

errorobjectverplicht

Eigenschappen tonen

codestringverplicht

messagestringverplicht

retryablebooleanverplicht

403

De toegangsgegevens missen de vereiste rechten.

errorobjectverplicht

Eigenschappen tonen

codestringverplicht

messagestringverplicht

retryablebooleanverplicht

404

De API of de gevraagde tool is niet beschikbaar.

errorobjectverplicht

Eigenschappen tonen

codestringverplicht

messagestringverplicht

retryablebooleanverplicht

413

Het verzoek overschrijdt de bytelimiet.

errorobjectverplicht

Eigenschappen tonen

codestringverplicht

Toegestane waarden:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringverplicht

min. lengte: 1 · max. lengte: 2048

retryablebooleanverplicht

okbooleanverplicht

toolNamestringverplicht

429

De limiet voor verzoeken is bereikt. Je kunt het opnieuw proberen.

errorobjectverplicht

Eigenschappen tonen

codestringverplicht

messagestringverplicht

retryablebooleanverplicht

503

De API of de dienst die de opdracht uitvoert is niet beschikbaar.

errorobjectverplicht

Eigenschappen tonen

codestringverplicht

messagestringverplicht

retryablebooleanverplicht

Verzoek

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}",
)

Antwoord

{
  "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
  }
}