Änderung vorbereiten

Bereite mit {input: {…}} eine Änderung vor. Die Vorbereitung genehmigt oder veröffentlicht nichts. Bei Erfolg werden confirmationCapability und expiresAt zurückgegeben; auch ein Tool-Fehler kann HTTP 200 verwenden. JSON-Anfragen sind auf 65536 Bytes begrenzt.

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

Autorisierung

AuthorizationBearer-Token · headererforderlich

Influence-API-Schlüssel mit begrenzten Berechtigungen oder unterstütztes OAuth-Zugriffstoken. Zugangsdaten gehören weder in URLs noch in Tool-Eingaben.

Pfadparameter

toolstringerforderlich

Von GET /api/v1/tools gelieferter Tool-Name. Die Liste wird nach den Berechtigungen der Zugangsdaten gefiltert; ein vorhandenes Schema garantiert keine Verfügbarkeit.

Anfrageinhalt

erforderlichapplication/json

inputobjecterforderlich

Antworten

200

Vorbereitung oder Tool-Fehler.

Mindestens eines von:

PreparedTool

confirmationCapabilitystringerforderlich

Sende diesen Wert vor expiresAt im Header X-Publish-Confirmation zurück.

min. Länge: 32 · max. Länge: 4096 · entspricht ^[A-Za-z0-9._~-]+$

expiresAtstring<date-time>erforderlich

entspricht ^(?:(?:\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)))$

inputDigeststringerforderlich

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

statusstringerforderlich

summary__schema0

Eigenschaften anzeigen

__schema0

toolNamestringerforderlich

Zulässige Werte:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListwhatsappContactListwhatsappTemplateListwhatsappMediaListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsToolgenerateVideoOptionsvideoFunctionToolgenerateVideoToolgenerateImageTooluploadFromUrlTool

ToolError

errorobjecterforderlich

Eigenschaften anzeigen

codestringerforderlich

Zulässige Werte:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringerforderlich

min. Länge: 1 · max. Länge: 2048

retryablebooleanerforderlich

okbooleanerforderlich

toolNamestringerforderlich

400

Ungültige Anfrage. Abfrageparameter werden nicht akzeptiert. Validierungsfehler können im Fehlerformat des Tools zurückgegeben werden.

Mindestens eines von:

TransportError

errorobjecterforderlich

Eigenschaften anzeigen

codestringerforderlich

messagestringerforderlich

retryablebooleanerforderlich

ToolError

errorobjecterforderlich

Eigenschaften anzeigen

codestringerforderlich

Zulässige Werte:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringerforderlich

min. Länge: 1 · max. Länge: 2048

retryablebooleanerforderlich

okbooleanerforderlich

toolNamestringerforderlich

401

Bearer-Zugangsdaten fehlen, sind ungültig oder abgelaufen.

errorobjecterforderlich

Eigenschaften anzeigen

codestringerforderlich

messagestringerforderlich

retryablebooleanerforderlich

403

Den Zugangsdaten fehlen erforderliche Berechtigungen.

errorobjecterforderlich

Eigenschaften anzeigen

codestringerforderlich

messagestringerforderlich

retryablebooleanerforderlich

404

Die API oder das angeforderte Tool ist nicht verfügbar.

errorobjecterforderlich

Eigenschaften anzeigen

codestringerforderlich

messagestringerforderlich

retryablebooleanerforderlich

413

Die Anfrage überschreitet das Byte-Limit.

errorobjecterforderlich

Eigenschaften anzeigen

codestringerforderlich

Zulässige Werte:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringerforderlich

min. Länge: 1 · max. Länge: 2048

retryablebooleanerforderlich

okbooleanerforderlich

toolNamestringerforderlich

429

Anfragelimit überschritten. Ein erneuter Versuch ist möglich.

errorobjecterforderlich

Eigenschaften anzeigen

codestringerforderlich

messagestringerforderlich

retryablebooleanerforderlich

503

Die API oder der ausführende Dienst ist nicht verfügbar.

errorobjecterforderlich

Eigenschaften anzeigen

codestringerforderlich

messagestringerforderlich

retryablebooleanerforderlich

Anfrage

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

Antwort

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