Preparar una modificación

Prepara una operación que modifica datos con {input: {…}}. La preparación no aprueba ni ejecuta la publicación. Si se completa, devuelve confirmationCapability y expiresAt; un error de herramienta también puede devolver HTTP 200. Las solicitudes JSON tienen un límite de 65536 bytes.

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

Autorización

AuthorizationToken Bearer · headerobligatorio

Clave de API de Influence con permisos limitados o token de acceso OAuth compatible. No incluyas credenciales en las URL ni en los datos de entrada de las herramientas.

Parámetros de ruta

toolstringobligatorio

Nombre de herramienta devuelto por GET /api/v1/tools. La lista depende de los permisos de las credenciales; la presencia de un esquema no garantiza disponibilidad.

Cuerpo de la solicitud

obligatorioapplication/json

inputobjectobligatorio

Respuestas

200

Preparación o error de herramienta.

Una o más de:

PreparedTool

confirmationCapabilitystringobligatorio

Devuelve este valor en la cabecera X-Publish-Confirmation antes de expiresAt.

longitud mín.: 32 · longitud máx.: 4096 · coincide con ^[A-Za-z0-9._~-]+$

expiresAtstring<date-time>obligatorio

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

inputDigeststringobligatorio

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

statusstringobligatorio

summary__schema0

Mostrar propiedades

__schema0

toolNamestringobligatorio

Valores permitidos:adAuditQuoteadAuditStartadAuditGetadAuditListsearchfetchprofileGetconnectionStatusGetaccountListwhatsappContactListwhatsappTemplateListwhatsappMediaListcampaignGetcampaignListcampaignDraftSavemediaListmediaImportmediaUploadCreatemediaUploadPartmediaUploadCompletemediaUploadGetmediaUploadAbortmediaGetcampaignReviewcampaignReviewGetcampaignReviewExecutecampaignScheduleBatchReviewcampaignScheduleBatchExecutescheduleListbrandContextGetinsightsAccountListinsightsPostListinsightsRefreshcampaignPlanGetcampaignPlanGenerateimageGenerationQuoteimageGenerationStartimageGenerationListintegrationListgroupListintegrationSchemadevtoOrganizationListdevtoTagListdiscordChannelListdiscourseCategoryListdiscourseTagListdiscourseTopicSearchdribbbleTeamListghostAuthorListghostNewsletterListghostTagListghostTierListhashnodePublicationListlemmyCommunitySearchlistmonkListsGetlistmonkTemplateListmattermostChannelListmeweGroupListpinterestBoardListredditSubredditRequirementsGetredditSubredditSearchslackChannelListteamsChannelListtiktokCreatorInfoGetvkDestinationListwhopCompanyListwhopExperienceListwordpressCategoryListwordpressPostTypeListwordpressTagListwrapcastChannelSearchintegrationSchedulePostToolpostsListToolpostSettingsToolgenerateVideoOptionsvideoFunctionToolgenerateVideoToolgenerateImageTooluploadFromUrlTool

ToolError

errorobjectobligatorio

Mostrar propiedades

codestringobligatorio

Valores permitidos:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringobligatorio

longitud mín.: 1 · longitud máx.: 2048

retryablebooleanobligatorio

okbooleanobligatorio

toolNamestringobligatorio

400

Solicitud no válida. No se aceptan parámetros de consulta. Los fallos de validación pueden usar el formato de error de la herramienta.

Una o más de:

TransportError

errorobjectobligatorio

Mostrar propiedades

codestringobligatorio

messagestringobligatorio

retryablebooleanobligatorio

ToolError

errorobjectobligatorio

Mostrar propiedades

codestringobligatorio

Valores permitidos:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringobligatorio

longitud mín.: 1 · longitud máx.: 2048

retryablebooleanobligatorio

okbooleanobligatorio

toolNamestringobligatorio

401

Credencial bearer ausente, no válida o caducada.

errorobjectobligatorio

Mostrar propiedades

codestringobligatorio

messagestringobligatorio

retryablebooleanobligatorio

403

Las credenciales no tienen los permisos necesarios.

errorobjectobligatorio

Mostrar propiedades

codestringobligatorio

messagestringobligatorio

retryablebooleanobligatorio

404

La API o la herramienta solicitada no está disponible.

errorobjectobligatorio

Mostrar propiedades

codestringobligatorio

messagestringobligatorio

retryablebooleanobligatorio

413

La solicitud supera el límite de bytes.

errorobjectobligatorio

Mostrar propiedades

codestringobligatorio

Valores permitidos:INVALID_INPUTFORBIDDENNOT_FOUNDCONFLICTFEATURE_DISABLEDCONFIRMATION_REQUIREDCONFIRMATION_INVALIDUPSTREAM_FAILEDNEEDS_REVIEWINTERNAL

messagestringobligatorio

longitud mín.: 1 · longitud máx.: 2048

retryablebooleanobligatorio

okbooleanobligatorio

toolNamestringobligatorio

429

Se ha superado el límite de solicitudes. Se puede reintentar.

errorobjectobligatorio

Mostrar propiedades

codestringobligatorio

messagestringobligatorio

retryablebooleanobligatorio

503

La API o el servicio que ejecuta la operación no está disponible.

errorobjectobligatorio

Mostrar propiedades

codestringobligatorio

messagestringobligatorio

retryablebooleanobligatorio

Solicitud

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

Respuesta

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