API referansı İngilizce yayımlanır.

Finish a gallery app connection and profile setup

POST/api/companies/{companyId}/tools/apps/{connectionId}/finish
Personal API keyAgent API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

Finish a gallery app connection and profile setup.

Yetkilendirme

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Anahtarlar nasıl çalışır.

Yol parametreleri

companyIdstringZorunluThe organization's id.
connectionIdstringZorunluThe connection's id.

İstek gövdesi

application/json · zorunlu

agentInstructionsobject | nullİsteğe bağlı
agentInstructions.enabledbooleanZorunlu
agentInstructions.textstringZorunlu1–2000 characters
agentInstructions.templateobjectİsteğe bağlı
agentInstructions.template.idstringZorunlu1–160 characters
agentInstructions.template.versionintegerZorunlu> 0
preserveExistingAccessbooleanİsteğe bağlı
enabledCatalogEntryIdsarray<string (uuid)>İsteğe bağlı
askFirstCatalogEntryIdsarray<string (uuid)>İsteğe bağlı
reviewedCatalogEntryIdsarray<string (uuid)>İsteğe bağlı
accessstring | objectZorunlu

Yanıtlar

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).

Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.

Connectors