{ "openapi": "3.0.1", "info": { "title": "API General Info", "version": "1.0", "description": "Support email: support@contentsnare.com |\nContacts |\nTerms of Service\n\n
\n

Enabling Cross-Account Access for Your API Application

\n

\nIf you are developing a custom integration that will be utilized by users across different Content Snare accounts, we require that you inform us when your application is ready for release so we can enable your API application for cross-account accessibility.\nPlease send your request to api@contentsnare.com.\n

\n
\n\nThe Content Snare API (further just the API) is an easy and secure way to have access to Content Snare data from\nthird-party applications. The API is built on REST principles and uses HTTP requests with JSON arguments and JSON\nresponses.\n\n### Authorization\n\nThe API accepts OAuth 2.0 access tokens and personal access tokens, or PATs. Send either credential in the\nAuthorization header:\n\n```text\nAuthorization: Bearer \n```\n\nUse OAuth for third-party or multi-customer applications. The authorization code flow is described below.\nOAuth authorization, token exchange, refresh, and API access require an active, non-archived administrator in the target company.\n\n#### Personal access tokens\n\nUse a personal access token for a private MCP server, script, or personal automation.\nEach token belongs to one member in one company and starts with `cs_pat_`.\nEnabled administrators can generate tokens. Enabled editors can generate tokens when their company permits it.\nReviewers, viewers, and clients cannot use personal access tokens.\n\n**Generate a token**\n\n1. Sign in to your company and open [Personal access tokens](https://app.contentsnare.com/settings/security/access-tokens).\n Select **Generate token**.\n If you use a company subdomain, open `/settings/security/access-tokens` on that company address.\n2. Enter a name for the integration and select only its required scopes.\n Administrators can select a lifetime. Editors always receive a 90-day token.\n3. Confirm with your current password. Supply an OTP if your account uses MFA and token OTP confirmation is enabled.\n4. Copy the token when it appears. The secret appears once. Store it in your integration's secret configuration.\n\nToken management requires your Content Snare session. You cannot create or manage tokens with a PAT through the Partner API.\nDo not register an OAuth application or use `/oauth/token` to generate or renew a PAT.\n\n**Use a token in this API reference**\n\n1. Use the documentation and API server for the environment that issued your token.\n Production requests use live company data. Check **API Servers** when server selection is available.\n2. Open **Authentication** and find **HTTP Bearer**, described as **Personal access token**.\n Remove any applied OAuth credential before this check.\n3. Paste only the complete `cs_pat_...` token into the `api-token` field, then select **SET**.\n Do not include `Bearer`. The documentation adds that prefix to the `Authorization` header.\n4. Open **Retrieve current API identity**, `GET /partner_api/v1/me`, under **Team members**, then select **TRY**.\n A successful response returns `200`, `credential_type: \"partner_api_token\"`, your token scopes, and its expiry.\n This endpoint requires a valid token but no additional scope.\n5. Try the required endpoints with scopes assigned to your token. Select **REMOVE** under **Authentication** after use.\n\nIf you open the downloaded specification in Swagger UI, select **Authorize**, then **PartnerApiToken**, and enter the raw token.\nOAuth client ID, client secret, and consent are not required for PAT access.\nThe scope requirements in each endpoint description apply to PATs as well as OAuth credentials.\n\n**Use a token from your integration**\n\nSend the token in the `Authorization` header. Use HTTPS in production.\nFor example, this read request requires `read_requests`:\n\n```sh\ncurl --url 'https://api.contentsnare.com/partner_api/v1/requests?limit=20&offset=0' \\\n --header \"Authorization: Bearer $CONTENT_SNARE_PARTNER_API_TOKEN\" \\\n --header 'Accept: application/json'\n```\n\nQuery parameters, form parameters, HTTP Basic authentication, and `X-API-Key` cannot authenticate PAT requests.\nDo not put tokens in URLs, source control, shared logs, LLM prompts, or tool arguments.\n\n**Lifetime, renewal, and access**\n\n- Administrators can choose 30, 60, 90, 180, 365, or 730 days by default. New administrator tokens default to 90 days.\n Editor tokens always last 90 days. Each member can have ten active tokens per company by default.\n- PATs have no refresh token. Use **Rotate token** in API settings to replace an expiring or expired token.\n Review the replacement scopes and lifetime. Rotation invalidates the previous secret immediately.\n Update every connected integration with the replacement. Other tokens remain unchanged.\n- The owner can rename, change permitted scopes, or revoke a token in API settings.\n Scope changes preserve the secret and expiry. They require current creator permission, password, and configured OTP confirmation.\n Rename and revoke do not require this confirmation.\n- Administrators can inspect company token metadata and revoke another member's token. They cannot retrieve its secret or rotate it.\n- Current member permissions, company API access, subscription, and MFA rules apply to every request.\n A policy change that blocks editor creation leaves existing tokens usable, subject to these access rules.\n An editor who cannot renew a token must contact an administrator before expiry.\n- Lifecycle emails go to the token owner. Name-only changes send no email.\n The owner receives one expiry notice within the final 24 hours, subject to company email restrictions and delivery availability.\n This notice has no configurable reminder schedule.\n\n`401` means the token is missing, invalid, expired, revoked, or sent through an unsupported transport.\n`403` means a required scope or current access rule denies the request.\nFor `429`, wait for the period in the `Retry-After` response header before retrying.\n\n### Scopes\n\nThe API uses scopes to determine the actions a credential may perform on Content Snare data. OAuth applications\nreceive scopes through the authorization code flow. PAT owners select scopes during generation, rotation, or a scope edit.\nAdministrators can select all scopes below. Editors cannot select write_team_members or\nadministration. Template sharing remains administrator-only.\nPATs do not accept the legacy aggregate read and write scopes.\nExisting OAuth scope behavior is unchanged. Full list of granular scopes:\n\n* read_clients - Read Clients\n* write_clients - Create/Update/Delete Clients\n* read_team_members - Read Team Members\n* write_team_members - Create/Update/Delete Team Members\n* read_requests - Read Requests\n* write_requests - Create/Update/Delete Requests\n* review_requests - Review Request Answers\n* read_templates - Read Templates\n* administration - Administration (webhook handling)\n\nInformation about scope requirements for specific API endpoints is in the description of these endpoints.\n\n### Authorization code flow\n\nBefore starting, you maybe generate an optional STATE to avoid CSRF attacks. The state should be a unique and non-guessable value.\nYou can include it to authorization url and it will be returned as a query parameter in the redirect\n(the details below).\n\n1\\. Request authorization code. To do that, you should redirect the user to the /oauth/authorization page with the following\nquery parameters:\n\n```text\nhttps://api.contentsnare.com/oauth/authorization?client_id=CLIENT_ID&redirect_uri=REDIRECT_URI&scope=REQUESTED_SCOPES&response_type=code&state=STATE\n```\n\nYou can build this url manually or use authorization url autogenerated after creation of API application on the Content Snare page \"Settings - API\".\nCLIENT_ID is Client ID that was obtained after such creation.\nREDIRECT_URI is redirect url that was set for the API application. REQUESTED_SCOPES is an optional space-separated list of scopes that will be asked to approve.\nIf it's omitted, the full set of scopes assigned to the configured in Content Snare API application having the CLIENT_ID will be used.\nFor example, scope=read_clients+write_clients requests the read_clients and write_clients scopes.\nThe scopes provided for the parameter REQUESTED_SCOPES must be from the ones that are set for the API application\nhaving the CLIENT_ID. If an unauthorised scope is set in the parameter scope then the error \"The requested scope is invalid, unknown, or malformed.\"\nis produced during the authorization process. The page associated with the authorization url asks the user to approve the request\nfrom the app to access their Content Snare account based on the scopes specified in REQUESTED_SCOPES.\nOnly administrators can authorize this OAuth flow. Editor PAT access does not change that rule.\nThe user is then redirected back to the specified REDIRECT_URI. The redirect includes the authorization code and STATE,\nfor example:\n\n```text\nhttps://example.com/oauth/redirect?code=gMEu3gfVmi-NZSAYZl5x6hJpnm4G9E3kT-OKmDd9zw8&state=STATE\n```\n\n2\\. With the authorization code returned from the previous request (shown as RETURNED_CODE in the following example), you can request an access_token.\nSend POST https://api.contentsnare.com/oauth/token with the following request body:\n\n```json\n{\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"code\": \"\",\n \"grant_type\": \"authorization_code\",\n \"redirect_uri\": \"https://example.com/oauth/redirect\"\n}\n```\n\nAlternatively, client_id and client_secret can be sent as part of the Authorization header. The Authorization header should contain Basic {base64_encode(CLIENT_ID + \":\" + APP_SECRET)}.\nThis endpoint should be called right after receiving the redirection request with the authorization code. The code is valid for 10 minutes only.\nExample response:\n\n```json\n{\n \"access_token\": \"YiTXJegP-Xd9LEQTXfWVB4NenTUZ8QOW-0THrFpAQ2U\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 7200,\n \"refresh_token\": \"87gPdV93UwEEiR-dnIAD2VO0aeQODFnizCgt1mgK0KI\",\n \"scope\": \"read_clients write_clients\",\n \"created_at\": 1607635748\n}\n```\n\nLifetime of access_token is 2 hours.\n\n3\\. To retrieve a new access_token, use the refresh_token parameter. Refresh tokens may be used even after the\naccess_token itself expires. Send POST https://api.contentsnare.com/oauth/token with the following request body:\n\n```json\n{\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"refresh_token\": \"X01Fgq4UjkzyPDfQ0LDaO5PSCsf7TvpDxpGACe98Wtw\",\n \"grant_type\": \"refresh_token\"\n}\n```\n\nAlternatively, client_id and client_secret can be sent as part of the Authorization header. The details are in point 2. Example response:\n\n```json\n{\n \"access_token\": \"6GEwpAM0X9DHgLJthN7kirteojNjKBomsnAdEO9dLok\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 7200,\n \"refresh_token\": \"WdehDTCHoA7ShwIQx08FNf74-imQzkAJFYrQZ9JQb5U\",\n \"scope\": \"read_requests write_requests\",\n \"created_at\": 1696240580\n}\n```\n\n### Revoke an OAuth token\n\nTo revoke an access/refresh token, use the /oauth/revoke endpoint.\nSend POST https://api.contentsnare.com/oauth/revoke with the following request body:\n\n```json\n{\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"token\": \"yEGOOdHy4Y32bfy0SOCUlCRoA3YiePSoQPQv67PnAgE\"\n}\n```\n\nThe endpoint returns a 200 response code and an empty JSON hash to indicate success.\n\n### HTTP response codes\n\n* **200, 201, 204 — Success** Everything went smooth.\n* **400 — Bad Request** The server could not understand the request because of invalid syntax. For example, malformed JSON.\n* **401 — Unauthorized** Missing or incorrect access token in header.\n* **403 — Forbidden** The credential lacks a required scope, or current account, company, or endpoint permissions deny access.\n* **404 — Not Found** The requested resource is not found.\n* **422 — Unprocessable Entity** The server understands the request (syntax of the request entity is correct) but\nit can't process the contained instructions. For example, the reason could be incorrect request attributes (empty name, unknown status, etc).\n* **429 — Too Many Requests** We have detected that you are making requests at a rate that exceeds acceptable use of\nthe API, you should reduce the rate at which you query the API. Details are in the section \"Partner API rate limits\".\n* **500 — Internal Server Error** This code indicates an issue on the server’s side.\n* **503 — Service Unavailable** API authentication is temporarily unavailable because required server configuration is incomplete.\n\n### Error format\n\nAs a rule, the server returns additional information about the error along with the error response code. Response body\ncontains error data in the following format:\n\n```json\n{\n \"errors\": [\n \"Error description 1\",\n \"Error description 2\"\n ]\n}\n```\n\n### Deprecated Partner API parameters\n\nDeprecated Partner API request parameters continue to work while replacements are introduced. When a deprecated\nparameter has public migration guidance, responses can include Deprecation,\nSunset, and Link headers. Use the\ndocumentation link to move to the replacement parameter before the sunset date.\n\n### Partner API rate limits\n\nPartner API requests are rate limited per access token when present, otherwise per IP. Current access-token limits are 50 read and 20 write requests per 10 seconds (subject to change).\nAuthentication helpers, PAT generation, rotation, and all token edits share an IP-based limit of 10 requests per 60 seconds.\nA company ceiling allows 3,000 requests per 60 seconds across its valid OAuth and PAT credentials and source IPs.\nA broader IP safety net allows 600 Partner API requests per 60 seconds to protect service stability.\nPartner API responses include the following headers for the request bucket currently governing the response:\n\n* X-RateLimit-Limit — Maximum requests allowed in the current window.\n* X-RateLimit-Remaining — Requests remaining in the current window after this request.\n* X-RateLimit-Reset — Time when the current window resets, as UTC epoch seconds.\n\nExceeding a rate limit, including sustained authentication-helper abuse, will result in an HTTP 429 (Too Many Requests) response. It will include http header Retry-After\nthat tells you how many seconds to wait before making another request.\n\nThese limits are in place to ensure the stability and performance of our service for all users.\n" }, "webhooks": { "client_created": { "post": { "summary": "Client created", "tags": [ "Clients" ], "requestBody": { "description": "Triggers when a new client is created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/client_created" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "client_updated": { "post": { "summary": "Client updated", "tags": [ "Clients" ], "requestBody": { "description": "Triggers when an existing client is updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/client_updated" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "client_destroyed": { "post": { "summary": "Client destroyed", "tags": [ "Clients" ], "requestBody": { "description": "Triggers when a client is deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/client_destroyed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "client_create_failed": { "post": { "summary": "Client create failed", "tags": [ "Clients" ], "requestBody": { "description": "Triggers when there is an error in creating a client", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/client_create_failed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "client_update_failed": { "post": { "summary": "Client update failed", "tags": [ "Clients" ], "requestBody": { "description": "Triggers when there is an error in updating a client", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/client_update_failed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "client_destroy_failed": { "post": { "summary": "Client destroy failed", "tags": [ "Clients" ], "requestBody": { "description": "Triggers when there is an error in deleting a client", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/client_destroy_failed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "id_verification_completed": { "post": { "summary": "Id verification completed", "tags": [ "Clients" ], "requestBody": { "description": "Triggers when an identity verification is completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/id_verification_completed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "id_verification_monitoring_updated": { "post": { "summary": "Id verification monitoring updated", "tags": [ "Clients" ], "requestBody": { "description": "Triggers when an identity verification monitoring check is updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/id_verification_monitoring_updated" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "id_verification_assets_redacted": { "post": { "summary": "Id verification assets redacted", "tags": [ "Clients" ], "requestBody": { "description": "Triggers when a reviewer redacts the documents, photos or videos of a client's identity checks", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/id_verification_assets_redacted" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "id_verification_client_marked_proceeding": { "post": { "summary": "Id verification client marked proceeding", "tags": [ "Clients" ], "requestBody": { "description": "Triggers when a reviewer marks a client's identity verification as Proceed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/id_verification_client_marked_proceeding" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "id_verification_client_marked_not_proceeding": { "post": { "summary": "Id verification client marked not proceeding", "tags": [ "Clients" ], "requestBody": { "description": "Triggers when a reviewer marks a client's identity verification as Don't Proceed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/id_verification_client_marked_not_proceeding" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "id_verification_client_mark_reset": { "post": { "summary": "Id verification client mark reset", "tags": [ "Clients" ], "requestBody": { "description": "Triggers when a reviewer resets a client's identity verification decision", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/id_verification_client_mark_reset" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "request_created": { "post": { "summary": "Request created", "tags": [ "Requests" ], "requestBody": { "description": "Triggers when a new request is created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/request_created" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "request_draft": { "post": { "summary": "Request draft", "tags": [ "Requests" ], "requestBody": { "description": "Triggers when a request draft is created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/request_draft" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "request_scheduled": { "post": { "summary": "Request scheduled", "tags": [ "Requests" ], "requestBody": { "description": "Triggers when a request is scheduled", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/request_scheduled" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "request_published": { "post": { "summary": "Request published", "tags": [ "Requests" ], "requestBody": { "description": "Triggers when a request is published", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/request_published" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "request_completed": { "post": { "summary": "Request completed", "tags": [ "Requests" ], "requestBody": { "description": "Triggers when a request is completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/request_completed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "request_archived": { "post": { "summary": "Request archived", "tags": [ "Requests" ], "requestBody": { "description": "Triggers when a request is archived", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/request_archived" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "request_updated": { "post": { "summary": "Request updated", "tags": [ "Requests" ], "requestBody": { "description": "Triggers when an existing request is updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/request_updated" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "request_destroyed": { "post": { "summary": "Request destroyed", "tags": [ "Requests" ], "requestBody": { "description": "Triggers when a request is deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/request_destroyed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "request_board_column_changed": { "post": { "summary": "Request board column changed", "tags": [ "Requests" ], "requestBody": { "description": "Triggers when the column on the request board is changed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/request_board_column_changed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "request_waiting_for_approval": { "post": { "summary": "Request waiting for approval", "tags": [ "Requests" ], "requestBody": { "description": "Triggers when request is waiting for approval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/request_waiting_for_approval" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "request_expired": { "post": { "summary": "Request expired", "tags": [ "Requests" ], "requestBody": { "description": "Triggers when a request set to expire passes its due date", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/request_expired" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "request_create_failed": { "post": { "summary": "Request create failed", "tags": [ "Requests" ], "requestBody": { "description": "Triggers when there is an error in creating a request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/request_create_failed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "request_update_failed": { "post": { "summary": "Request update failed", "tags": [ "Requests" ], "requestBody": { "description": "Triggers when there is an error in updating a request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/request_update_failed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "request_destroy_failed": { "post": { "summary": "Request destroy failed", "tags": [ "Requests" ], "requestBody": { "description": "Triggers when there is an error in deleting a request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/request_destroy_failed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "request_published_failed": { "post": { "summary": "Request published failed", "tags": [ "Requests" ], "requestBody": { "description": "Triggers when there is an error in publishing a request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/request_published_failed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "request_completed_failed": { "post": { "summary": "Request completed failed", "tags": [ "Requests" ], "requestBody": { "description": "Triggers when there is an error in completing a request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/request_completed_failed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "request_archived_failed": { "post": { "summary": "Request archived failed", "tags": [ "Requests" ], "requestBody": { "description": "Triggers when there is an error in archiving a request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/request_archived_failed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "request_board_column_change_failed": { "post": { "summary": "Request board column change failed", "tags": [ "Requests" ], "requestBody": { "description": "Triggers when there is an error in changing the column on the request board", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/request_board_column_change_failed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "scheduled_request_failed_to_publish": { "post": { "summary": "Scheduled request failed to publish", "tags": [ "Requests" ], "requestBody": { "description": "Triggers when a scheduled request can't be published because of reaching your maximum request limit in Content Snare", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/scheduled_request_failed_to_publish" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "scheduled_request_published_but_limits_exceeded": { "post": { "summary": "Scheduled request published but limits exceeded", "tags": [ "Requests" ], "requestBody": { "description": "Triggers when a scheduled request is published over your request limit in Content Snare", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/scheduled_request_published_but_limits_exceeded" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "request_viewed": { "post": { "summary": "Request viewed", "tags": [ "Requests" ], "requestBody": { "description": "Triggers when a request is viewed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/request_viewed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "request_exported": { "post": { "summary": "Request exported", "tags": [ "Requests" ], "requestBody": { "description": "Triggers when a request is exported", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/request_exported" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "request_owner_reassigned": { "post": { "summary": "Request owner reassigned", "tags": [ "Requests" ], "requestBody": { "description": "Triggers when a request owner is reassigned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/request_owner_reassigned" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "recurring_request_created": { "post": { "summary": "Recurring request created", "tags": [ "Recurring requests" ], "requestBody": { "description": "Triggers whenever a recurring request is created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/recurring_request_created" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "recurring_request_destroyed": { "post": { "summary": "Recurring request destroyed", "tags": [ "Recurring requests" ], "requestBody": { "description": "Triggers whenever a recurring request is deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/recurring_request_destroyed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "recurring_request_executed": { "post": { "summary": "Recurring request executed", "tags": [ "Recurring requests" ], "requestBody": { "description": "Triggers when a recurring request runs on its schedule or when a bulk request starts creating requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/recurring_request_executed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "recurring_request_completed": { "post": { "summary": "Recurring request completed", "tags": [ "Recurring requests" ], "requestBody": { "description": "Triggers whenever a recurring request completes the last recurrence in it's schedule or a bulk request has finished creating the requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/recurring_request_completed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "recurring_request_failed": { "post": { "summary": "Recurring request failed", "tags": [ "Recurring requests" ], "requestBody": { "description": "Triggers when a recurring request run is failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/recurring_request_failed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "team_member_created": { "post": { "summary": "Team member created", "tags": [ "Team members" ], "requestBody": { "description": "Triggers when a new team member is added", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/team_member_created" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "team_member_updated": { "post": { "summary": "Team member updated", "tags": [ "Team members" ], "requestBody": { "description": "Triggers when an existing team member is updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/team_member_updated" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "team_member_destroyed": { "post": { "summary": "Team member destroyed", "tags": [ "Team members" ], "requestBody": { "description": "Triggers when a team member is removed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/team_member_destroyed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "team_member_create_failed": { "post": { "summary": "Team member create failed", "tags": [ "Team members" ], "requestBody": { "description": "Triggers when there is an error in adding a team member", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/team_member_create_failed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "team_member_update_failed": { "post": { "summary": "Team member update failed", "tags": [ "Team members" ], "requestBody": { "description": "Triggers when there is an error in updating a team member", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/team_member_update_failed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "team_member_destroy_failed": { "post": { "summary": "Team member destroy failed", "tags": [ "Team members" ], "requestBody": { "description": "Triggers when there is an error in removing a team member", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/team_member_destroy_failed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "comment_created": { "post": { "summary": "Comment created", "tags": [ "Comments" ], "requestBody": { "description": "Triggers when a new comment is created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/comment_created" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "internal_comment_created": { "post": { "summary": "Internal comment created", "tags": [ "Comments" ], "requestBody": { "description": "Triggers when a new internal comment is created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/internal_comment_created" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "comment_create_failed": { "post": { "summary": "Comment create failed", "tags": [ "Comments" ], "requestBody": { "description": "Triggers when there is an error in creating a comment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/comment_create_failed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "email_delivered": { "post": { "summary": "Email delivered", "tags": [ "Communication" ], "requestBody": { "description": "Triggers when an email is successfully delivered to the recipient", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/email_delivered" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "email_bounced": { "post": { "summary": "Email bounced", "tags": [ "Communication" ], "requestBody": { "description": "Triggers when an email delivery fails due to a bounce-back message", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/email_bounced" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "email_spam_complained": { "post": { "summary": "Email spam complained", "tags": [ "Communication" ], "requestBody": { "description": "Triggers when an email is marked as spam by the recipient", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/email_spam_complained" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "sms_delivered": { "post": { "summary": "Sms delivered", "tags": [ "Communication" ], "requestBody": { "description": "Triggers when an SMS message is successfully delivered", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/sms_delivered" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "sms_failed": { "post": { "summary": "Sms failed", "tags": [ "Communication" ], "requestBody": { "description": "Triggers when an SMS message delivery fails", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/sms_failed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "product_item_used": { "post": { "summary": "Product item used", "tags": [ "Billing" ], "requestBody": { "description": "Triggers when a product item is used", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/product_item_used" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "product_item_returned": { "post": { "summary": "Product item returned", "tags": [ "Billing" ], "requestBody": { "description": "Triggers when a product item is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/product_item_returned" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "product_item_exhausted": { "post": { "summary": "Product item exhausted", "tags": [ "Billing" ], "requestBody": { "description": "Triggers when a product is not available for purchase", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/product_item_exhausted" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "product_item_manual_purchase": { "post": { "summary": "Product item manual purchase", "tags": [ "Billing" ], "requestBody": { "description": "Triggers when a product item is manually purchased", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/product_item_manual_purchase" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "product_item_auto_purchase": { "post": { "summary": "Product item auto purchase", "tags": [ "Billing" ], "requestBody": { "description": "Triggers when a product item is automatically purchased", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/product_item_auto_purchase" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "product_item_purchase_failed": { "post": { "summary": "Product item purchase failed", "tags": [ "Billing" ], "requestBody": { "description": "Triggers when a purchase of a product item fails", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/product_item_purchase_failed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "field_completed": { "post": { "summary": "Field completed", "tags": [ "Fields" ], "requestBody": { "description": "Triggers when a specific field is completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/field_completed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "field_approved": { "post": { "summary": "Field approved", "tags": [ "Fields" ], "requestBody": { "description": "Triggers when a field is approved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/field_approved" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "field_rejected": { "post": { "summary": "Field rejected", "tags": [ "Fields" ], "requestBody": { "description": "Triggers when a field is rejected", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/field_rejected" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "all_fields_completed": { "post": { "summary": "All fields completed", "tags": [ "Fields" ], "requestBody": { "description": "Triggers when all fields are completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/all_fields_completed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "page_completed": { "post": { "summary": "Page completed", "tags": [ "Fields" ], "requestBody": { "description": "Triggers when all fields in the page are completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/page_completed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "section_completed": { "post": { "summary": "Section completed", "tags": [ "Fields" ], "requestBody": { "description": "Triggers when all fields in the section are completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/section_completed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "signature_completed": { "post": { "summary": "Signature completed", "tags": [ "Fields" ], "requestBody": { "description": "Triggers when a signature field is completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/signature_completed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "webhook_delivery_failed": { "post": { "summary": "Webhook delivery failed", "tags": [ "Webhooks" ], "requestBody": { "description": "Triggers when a webhook delivery fails", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/webhook_delivery_failed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "integration_action_succeeded": { "post": { "summary": "Integration action succeeded", "tags": [ "Integration actions" ], "requestBody": { "description": "Triggers when an integration action is successfully run", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/integration_action_succeeded" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } }, "integration_action_failed": { "post": { "summary": "Integration action failed", "tags": [ "Integration actions" ], "requestBody": { "description": "Triggers when an error occurs while running an integration action", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook_payloads/integration_action_failed" } } } }, "responses": { "200": { "description": "Return a 2xx status code to indicate that the data was received successfully" } } } } }, "paths": { "/partner_api/v1/client_companies": { "get": { "summary": "List client companies", "tags": [ "Client companies" ], "description": "Returns list of client companies
Required scopes: read_clients", "security": [ { "OAuth2": [ "read_clients" ] }, { "PartnerApiToken": [] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Specifies the maximum number of returned items", "schema": { "$ref": "#/components/schemas/limit" }, "required": false }, { "name": "offset", "in": "query", "description": "Specifies how many items to skip from the beginning", "schema": { "$ref": "#/components/schemas/offset" }, "required": false }, { "name": "q", "in": "query", "description": "String to search in the values specified in the parameter `q_by[]`", "required": false, "schema": { "type": "string" } }, { "name": "q_by[]", "in": "query", "description": "Specifies list of values where string from the parameter `q` will be searched. If it isn't set then the default list is used.
Examples: q_by[]=name", "schema": { "$ref": "#/components/schemas/q_by_client_companies" }, "required": false }, { "name": "sort_by", "in": "query", "description": "Specifies value for sorting", "schema": { "$ref": "#/components/schemas/sort_by_client_companies" }, "required": false }, { "name": "sort_direction", "in": "query", "description": "Specifies direction for sorting", "schema": { "$ref": "#/components/schemas/sort_direction" }, "required": false } ], "responses": { "200": { "description": "successful", "content": { "application/json": { "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/pagination_client_companies" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/client_company" } } } } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } } } }, "/partner_api/v1/clients": { "post": { "summary": "Create client", "tags": [ "Clients" ], "description": "Creates a new client
Required scopes: write_clients", "security": [ { "OAuth2": [ "write_clients" ] }, { "PartnerApiToken": [] } ], "parameters": [], "responses": { "201": { "description": "successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client" } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "422": { "description": "unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/new_client" } } }, "required": true, "description": "New client attributes" } }, "get": { "summary": "List clients", "tags": [ "Clients" ], "description": "Returns list of active clients
Required scopes: read_clients", "security": [ { "OAuth2": [ "read_clients" ] }, { "PartnerApiToken": [] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Specifies the maximum number of returned items", "schema": { "$ref": "#/components/schemas/limit" }, "required": false }, { "name": "offset", "in": "query", "description": "Specifies how many items to skip from the beginning", "schema": { "$ref": "#/components/schemas/offset" }, "required": false }, { "name": "include_external", "in": "query", "description": "Specifies whether to return clients from external sources (integrations) (include_external=true)", "required": false, "schema": { "type": "boolean" } }, { "name": "q", "in": "query", "description": "String to search in the values specified in the parameter `q_by[]`", "required": false, "schema": { "type": "string" } }, { "name": "q_by[]", "in": "query", "description": "Specifies list of values where string from the parameter `q` will be searched. If it isn't set then the default list is used.
Examples: q_by[]=email&q_by[]=full_name", "schema": { "$ref": "#/components/schemas/q_by_clients" }, "required": false }, { "name": "filter_by[email]", "in": "query", "description": "Exact email filter. Matches the full email value case-insensitively; use q/q_by[] for substring search.", "schema": { "$ref": "#/components/schemas/filter_by_client_email" }, "required": false }, { "name": "filter_by[full_name]", "in": "query", "description": "Exact full name filter. Matches the full client name value; use q/q_by[] for substring search.", "schema": { "$ref": "#/components/schemas/filter_by_client_full_name" }, "required": false }, { "name": "filter_by[phone]", "in": "query", "description": "Exact phone filter. Matches the full phone value; use q/q_by[] for substring search.", "schema": { "$ref": "#/components/schemas/filter_by_client_phone" }, "required": false }, { "name": "sort_by", "in": "query", "description": "Specifies value for sorting", "schema": { "$ref": "#/components/schemas/sort_by_clients" }, "required": false }, { "name": "sort_direction", "in": "query", "description": "Specifies direction for sorting", "schema": { "$ref": "#/components/schemas/sort_direction" }, "required": false } ], "responses": { "200": { "description": "successful", "content": { "application/json": { "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/pagination_clients" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/client" } } } } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } } } }, "/partner_api/v1/clients/{id}": { "delete": { "summary": "Delete client", "tags": [ "Clients" ], "description": "Deletes a client with specific ID
Required scopes: write_clients", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "write_clients" ] }, { "PartnerApiToken": [] } ], "responses": { "204": { "description": "successful" }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "404": { "description": "not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "422": { "description": "unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } } }, "get": { "summary": "Find client by ID", "tags": [ "Clients" ], "description": "Returns a client with specific ID
Required scopes: read_clients", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "read_clients" ] }, { "PartnerApiToken": [] } ], "responses": { "200": { "description": "successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client" } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "404": { "description": "not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } } }, "put": { "summary": "Update client", "tags": [ "Clients" ], "description": "Updates a client
Required scopes: write_clients", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "write_clients" ] }, { "PartnerApiToken": [] } ], "responses": { "200": { "description": "successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/client" } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "404": { "description": "not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "422": { "description": "unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_client" } } }, "required": true, "description": "Updated client attributes" } } }, "/partner_api/v1/communication_templates": { "get": { "summary": "List communications schedules", "tags": [ "Communications schedules" ], "description": "Returns list of communications schedules
Required scopes: read_requests", "security": [ { "OAuth2": [ "read_requests" ] }, { "PartnerApiToken": [] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Specifies the maximum number of returned items", "schema": { "$ref": "#/components/schemas/limit" }, "required": false }, { "name": "offset", "in": "query", "description": "Specifies how many items to skip from the beginning", "schema": { "$ref": "#/components/schemas/offset" }, "required": false }, { "name": "filter_by[source]", "in": "query", "description": "Filters templates by source. Use `company` to exclude built-in templates from dropdowns. Supported values: `company`, `built_in`, `shared` (`shared` returns no communication templates for communication template endpoints).
Examples: filter_by[source]=company", "schema": { "$ref": "#/components/schemas/filter_by_template_source" }, "required": false } ], "responses": { "200": { "description": "successful", "content": { "application/json": { "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/pagination_templates" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/communication_template" } } } } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } } } }, "/partner_api/v1/fields/{id}/review": { "put": { "summary": "Review request", "tags": [ "Requests" ], "description": "Changes field status and individual answer statuses within field
Required scopes: review_requests", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "review_requests" ] }, { "PartnerApiToken": [] } ], "responses": { "200": { "description": "successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reviewed_field" } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "404": { "description": "not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "422": { "description": "unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/review_field" } } }, "required": true, "description": "Updated field attributes" } } }, "/partner_api/v1/folders": { "get": { "summary": "List folders", "tags": [ "Folders" ], "description": "Returns list of folders
Required scopes: read_requests", "security": [ { "OAuth2": [ "read_requests" ] }, { "PartnerApiToken": [] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Specifies the maximum number of returned items", "schema": { "$ref": "#/components/schemas/limit" }, "required": false }, { "name": "offset", "in": "query", "description": "Specifies how many items to skip from the beginning", "schema": { "$ref": "#/components/schemas/offset" }, "required": false } ], "responses": { "200": { "description": "successful", "content": { "application/json": { "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/pagination" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/folder" } } } } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } } } }, "/partner_api/v1/me": { "get": { "summary": "Retrieve current API identity", "tags": [ "Team members" ], "description": "Returns the authenticated team member's name and safe details about the credential used for this request, including its type, scopes, and expiry.
Required scopes: -", "security": [ { "OAuth2": [] }, { "PartnerApiToken": [] } ], "responses": { "200": { "description": "successful", "content": { "application/json": { "schema": { "type": "object", "required": [ "full_name", "message", "credential_type", "scopes", "expires_at" ], "properties": { "full_name": { "type": "string", "example": "Clay Schaden" }, "message": { "type": "string", "example": "Clay Schaden" }, "credential_type": { "type": "string", "enum": [ "oauth", "partner_api_token" ], "example": "partner_api_token" }, "scopes": { "type": "array", "items": { "type": "string" }, "example": [ "read_requests" ] }, "expires_at": { "type": "string", "format": "date-time", "nullable": true, "example": "2026-12-31T23:59:59Z" } } } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "503": { "description": "API token service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } } } }, "/partner_api/v1/page_templates": { "get": { "summary": "List page templates", "tags": [ "Templates" ], "description": "Returns list of page templates
Required scopes: read_templates", "security": [ { "OAuth2": [ "read_templates" ] }, { "PartnerApiToken": [] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Specifies the maximum number of returned items", "schema": { "$ref": "#/components/schemas/limit" }, "required": false }, { "name": "offset", "in": "query", "description": "Specifies how many items to skip from the beginning", "schema": { "$ref": "#/components/schemas/offset" }, "required": false }, { "name": "filter_by[source]", "in": "query", "description": "Filters templates by source. Use `company` to exclude built-in templates from dropdowns. Supported values: `company`, `built_in`, `shared` (`shared` returns no communication templates for communication template endpoints).
Examples: filter_by[source]=company", "schema": { "$ref": "#/components/schemas/filter_by_template_source" }, "required": false } ], "responses": { "200": { "description": "successful", "content": { "application/json": { "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/pagination_templates" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/tab_template" } } } } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } } } }, "/partner_api/v1/request_templates": { "get": { "summary": "List request templates", "tags": [ "Templates" ], "description": "Returns list of request templates
Required scopes: read_templates", "security": [ { "OAuth2": [ "read_templates" ] }, { "PartnerApiToken": [] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Specifies the maximum number of returned items", "schema": { "$ref": "#/components/schemas/limit" }, "required": false }, { "name": "offset", "in": "query", "description": "Specifies how many items to skip from the beginning", "schema": { "$ref": "#/components/schemas/offset" }, "required": false }, { "name": "filter_by[source]", "in": "query", "description": "Filters templates by source. Use `company` to exclude built-in templates from dropdowns. Supported values: `company`, `built_in`, `shared` (`shared` returns no communication templates for communication template endpoints).
Examples: filter_by[source]=company", "schema": { "$ref": "#/components/schemas/filter_by_template_source" }, "required": false } ], "responses": { "200": { "description": "successful", "content": { "application/json": { "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/pagination_templates" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/request_template" } } } } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } } } }, "/partner_api/v1/requests/{id}/approve_all_submitted_fields": { "put": { "summary": "Approve all submitted fields", "tags": [ "Requests" ], "description": "Approves all submitted for review fields in request (sets status \"approved\" for all fields)
Required scopes: review_requests", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "review_requests" ] }, { "PartnerApiToken": [] } ], "responses": { "200": { "description": "successful" }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "404": { "description": "not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } } } }, "/partner_api/v1/requests/{id}/submit_all_fields": { "put": { "summary": "Submit all fields for review", "tags": [ "Requests" ], "description": "Submits all fields in request for review (sets status \"done\" for all fields)
Required scopes: review_requests", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "review_requests" ] }, { "PartnerApiToken": [] } ], "responses": { "200": { "description": "successful" }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "404": { "description": "not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } } } }, "/partner_api/v1/requests": { "post": { "summary": "Create request", "tags": [ "Requests" ], "description": "Creates a new request. Use `client_id` to assign one existing client, or `client_assignments` to assign multiple clients by ID. Add `write_clients` only when creating a new client from email fields. If `build_status` is `building`, poll the request by ID until it is `ready` or `failed`.
Required scopes: write_requests", "security": [ { "OAuth2": [ "write_requests" ] }, { "OAuth2": [ "write_requests", "write_clients" ] }, { "PartnerApiToken": [] } ], "parameters": [], "responses": { "201": { "description": "successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/created_or_updated_request" } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "422": { "description": "unprocessable entity", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/errors_object" }, { "$ref": "#/components/schemas/assignment_validation_errors_object" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/new_request" } } }, "required": true, "description": "New request attributes" } }, "get": { "summary": "List requests", "tags": [ "Requests" ], "description": "Returns list of requests
Required scopes: read_requests", "security": [ { "OAuth2": [ "read_requests" ] }, { "PartnerApiToken": [] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Specifies the maximum number of returned items", "schema": { "$ref": "#/components/schemas/limit" }, "required": false }, { "name": "offset", "in": "query", "description": "Specifies how many items to skip from the beginning", "schema": { "$ref": "#/components/schemas/offset" }, "required": false }, { "name": "q", "in": "query", "description": "String to search in the values specified in the parameter `q_by[]`", "required": false, "schema": { "type": "string" } }, { "name": "q_by[]", "in": "query", "description": "Specifies list of values where string from the parameter `q` will be searched. If it isn't set then the default list is used.
Examples: q_by[]=name&q_by[]=clients.full_name&q_by[]=client_companies.name", "schema": { "$ref": "#/components/schemas/q_by_requests" }, "required": false }, { "name": "filter_by[statuses][]", "in": "query", "description": "Specifies list of statuses for filtering
Examples: filter_by[statuses][]=published&filter_by[statuses][]=completed", "schema": { "$ref": "#/components/schemas/filter_by_request_statuses" }, "required": false }, { "name": "sort_by", "in": "query", "description": "Specifies value for sorting", "schema": { "$ref": "#/components/schemas/sort_by_requests" }, "required": false }, { "name": "sort_direction", "in": "query", "description": "Specifies direction for sorting", "schema": { "$ref": "#/components/schemas/sort_direction" }, "required": false }, { "name": "expand[]", "description": "Include additional data in response
Examples: expand[]=request_template_name&expand[]=owner_email&expand[]=owner_name&expand[]=clients
expand[]=published_at&expand[]=all_fields_completed_at&expand[]=last_client_field_completed_at&expand[]=last_team_field_reviewed_at", "in": "query", "required": false, "type": "array", "collectionFormat": "multi", "schema": { "type": "array", "items": { "type": "string", "enum": [ "request_template_name", "owner_email", "owner_name", "published_at", "all_fields_completed_at", "last_client_field_completed_at", "last_team_field_reviewed_at", "clients" ], "default": [] } } } ], "responses": { "200": { "description": "successful", "content": { "application/json": { "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/pagination_requests" }, "results": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/index_request" }, { "$ref": "#/components/schemas/index_request_with_expand" } ] } } } } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } } } }, "/partner_api/v1/requests/{id}": { "delete": { "summary": "Delete request", "tags": [ "Requests" ], "description": "Deletes a request with specific ID
Required scopes: write_requests", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "write_requests" ] }, { "PartnerApiToken": [] } ], "responses": { "204": { "description": "successful" }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "404": { "description": "not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } } }, "get": { "summary": "Find request by ID", "tags": [ "Requests" ], "description": "Returns a request with specific ID. For asynchronous request creation, poll about every 10 seconds while `build_status` is `building`; stop on `ready` or `failed`. After a 10-minute client deadline, preserve the request ID and report it as pending rather than failed. Honor `Retry-After` on 429, use exponential backoff capped at 60 seconds on 5xx, and stop on 404.
Required scopes: read_requests", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "read_requests" ] }, { "PartnerApiToken": [] } ], "responses": { "200": { "description": "successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/show_request" } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "404": { "description": "not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } } }, "put": { "summary": "Update request", "tags": [ "Requests" ], "description": "Updates a request. Use `client_assignments` to assign one or more clients by ID.
Required scopes: write_requests", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "write_requests" ] }, { "PartnerApiToken": [] } ], "responses": { "200": { "description": "successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/created_or_updated_request" } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "404": { "description": "not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "429": { "description": "too many requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "422": { "description": "unprocessable entity", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/errors_object" }, { "$ref": "#/components/schemas/assignment_validation_errors_object" } ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_request" } } }, "required": true, "description": "Updated request attributes" } } }, "/partner_api/v1/requests/{id}/run_integration_actions": { "put": { "summary": "Run integration actions", "tags": [ "Requests" ], "description": "Runs integration actions inside a request with specific ID
Required scopes: review_requests", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "review_requests" ] }, { "PartnerApiToken": [] } ], "responses": { "200": { "description": "successful" }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "404": { "description": "not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "422": { "description": "unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object_with_extra_integration_action_data" } } } } } } }, "/partner_api/v1/section_templates": { "get": { "summary": "List section templates", "tags": [ "Templates" ], "description": "Returns list of section templates
Required scopes: read_templates", "security": [ { "OAuth2": [ "read_templates" ] }, { "PartnerApiToken": [] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Specifies the maximum number of returned items", "schema": { "$ref": "#/components/schemas/limit" }, "required": false }, { "name": "offset", "in": "query", "description": "Specifies how many items to skip from the beginning", "schema": { "$ref": "#/components/schemas/offset" }, "required": false }, { "name": "filter_by[source]", "in": "query", "description": "Filters templates by source. Use `company` to exclude built-in templates from dropdowns. Supported values: `company`, `built_in`, `shared` (`shared` returns no communication templates for communication template endpoints).
Examples: filter_by[source]=company", "schema": { "$ref": "#/components/schemas/filter_by_template_source" }, "required": false } ], "responses": { "200": { "description": "successful", "content": { "application/json": { "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/pagination_templates" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/section_template" } } } } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } } } }, "/partner_api/v1/sections/{id}/approve_all_submitted_fields": { "put": { "summary": "Approve all submitted section fields", "tags": [ "Sections" ], "description": "Approves all submitted for review fields in section (sets status \"approved\" for all fields)
Required scopes: review_requests", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "review_requests" ] }, { "PartnerApiToken": [] } ], "responses": { "200": { "description": "successful" }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "404": { "description": "not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } } } }, "/partner_api/v1/sections/{id}/submit_all_fields": { "put": { "summary": "Submit all section fields for review", "tags": [ "Sections" ], "description": "Submits all fields in section for review (sets status \"done\" for all fields)
Required scopes: review_requests", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "review_requests" ] }, { "PartnerApiToken": [] } ], "responses": { "200": { "description": "successful" }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "404": { "description": "not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } } } }, "/partner_api/v1/sections": { "post": { "summary": "Create section", "tags": [ "Sections" ], "description": "Creates a new section in page
Required scopes: write_requests", "security": [ { "OAuth2": [ "write_requests" ] }, { "PartnerApiToken": [] } ], "parameters": [], "responses": { "201": { "description": "successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/section" } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "404": { "description": "not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "422": { "description": "unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/new_section" } } }, "required": true, "description": "New section attributes" } } }, "/partner_api/v1/pages/{id}/approve_all_submitted_fields": { "put": { "summary": "Approve all submitted page fields", "tags": [ "Pages" ], "description": "Approves all submitted for review fields in page (sets status \"approved\" for all fields)
Required scopes: review_requests", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "review_requests" ] }, { "PartnerApiToken": [] } ], "responses": { "200": { "description": "successful" }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "404": { "description": "not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } } } }, "/partner_api/v1/pages/{id}/submit_all_fields": { "put": { "summary": "Submit all page fields for review", "tags": [ "Pages" ], "description": "Submits all fields in page for review (sets status \"done\" for all fields)
Required scopes: review_requests", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "review_requests" ] }, { "PartnerApiToken": [] } ], "responses": { "200": { "description": "successful" }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "404": { "description": "not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } } } }, "/partner_api/v1/pages": { "post": { "summary": "Create page", "tags": [ "Pages" ], "description": "Creates a new page in request
Required scopes: write_requests", "security": [ { "OAuth2": [ "write_requests" ] }, { "PartnerApiToken": [] } ], "parameters": [], "responses": { "201": { "description": "successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tab" } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "404": { "description": "not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "422": { "description": "unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/new_tab" } } }, "required": true, "description": "New page attributes" } } }, "/partner_api/v1/pages/{id}": { "get": { "summary": "Find page by ID", "tags": [ "Pages" ], "description": "Returns a page with specific ID
Required scopes: read_requests", "security": [ { "OAuth2": [ "read_requests" ] }, { "PartnerApiToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "include_internal_fields", "in": "query", "description": "Specifies whether to include fields marked as internal in the response", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tab" } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "404": { "description": "not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } } } }, "/partner_api/v1/team_members": { "post": { "summary": "Create team member", "tags": [ "Team members" ], "description": "Creates a new team member
Required scopes: write_team_members", "security": [ { "OAuth2": [ "write_team_members" ] }, { "PartnerApiToken": [] } ], "parameters": [], "responses": { "201": { "description": "successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team_member" } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "422": { "description": "unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/new_team_member" } } }, "required": true, "description": "New team member attributes" } }, "get": { "summary": "List team members", "tags": [ "Team members" ], "description": "Returns list of team members
Required scopes: read_team_members", "security": [ { "OAuth2": [ "read_team_members" ] }, { "PartnerApiToken": [] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Specifies the maximum number of returned items", "schema": { "$ref": "#/components/schemas/limit" }, "required": false }, { "name": "offset", "in": "query", "description": "Specifies how many items to skip from the beginning", "schema": { "$ref": "#/components/schemas/offset" }, "required": false }, { "name": "q", "in": "query", "description": "String to search in the values specified in the parameter `q_by[]`", "required": false, "schema": { "type": "string" } }, { "name": "q_by[]", "in": "query", "description": "Specifies list of values where string from the parameter `q` will be searched. If it isn't set then the default list is used.
Examples: q_by[]=full_name&q_by[]=phone", "schema": { "$ref": "#/components/schemas/q_by_team_members" }, "required": false }, { "name": "sort_by", "in": "query", "description": "Specifies value for sorting", "schema": { "$ref": "#/components/schemas/sort_by_team_members" }, "required": false }, { "name": "sort_direction", "in": "query", "description": "Specifies direction for sorting", "schema": { "$ref": "#/components/schemas/sort_direction" }, "required": false } ], "responses": { "200": { "description": "successful", "content": { "application/json": { "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/pagination_team_members" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/team_member" } } } } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } } } }, "/partner_api/v1/team_members/{id}": { "delete": { "summary": "Delete team member", "tags": [ "Team members" ], "description": "Deletes a team member with specific ID
Required scopes: write_team_members", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "write_team_members" ] }, { "PartnerApiToken": [] } ], "responses": { "204": { "description": "successful" }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "404": { "description": "not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } } }, "get": { "summary": "Find team member by ID", "tags": [ "Team members" ], "description": "Returns a team member with specific ID
Required scopes: read_team_members", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "read_team_members" ] }, { "PartnerApiToken": [] } ], "responses": { "200": { "description": "successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team_member" } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "404": { "description": "not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } } }, "put": { "summary": "Update team member", "tags": [ "Team members" ], "description": "Updates a team member
Required scopes: write_team_members", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "write_team_members" ] }, { "PartnerApiToken": [] } ], "responses": { "200": { "description": "successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/team_member" } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "404": { "description": "not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "422": { "description": "unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/update_team_member" } } }, "required": true, "description": "Updated team member attributes" } } }, "/partner_api/v1/webhooks": { "post": { "summary": "Create webhook", "tags": [ "Webhooks" ], "description": "Creates a new webhook
Required scopes: administration", "security": [ { "OAuth2": [ "administration" ] }, { "PartnerApiToken": [] } ], "parameters": [], "responses": { "201": { "description": "successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "422": { "description": "unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/new_or_update_webhook" } } }, "required": true, "description": "New webhook attributes" } }, "get": { "summary": "List webhooks", "tags": [ "Webhooks" ], "description": "Returns list of webhooks
Required scopes: administration", "security": [ { "OAuth2": [ "administration" ] }, { "PartnerApiToken": [] } ], "parameters": [ { "name": "limit", "in": "query", "description": "Specifies the maximum number of returned items", "schema": { "$ref": "#/components/schemas/limit" }, "required": false }, { "name": "offset", "in": "query", "description": "Specifies how many items to skip from the beginning", "schema": { "$ref": "#/components/schemas/offset" }, "required": false } ], "responses": { "200": { "description": "successful", "content": { "application/json": { "schema": { "type": "object", "properties": { "pagination": { "$ref": "#/components/schemas/pagination" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/webhook" } } } } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } } } }, "/partner_api/v1/webhooks/{id}": { "delete": { "summary": "Delete webhook", "tags": [ "Webhooks" ], "description": "Deletes a webhook with specific ID
Required scopes: administration", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "administration" ] }, { "PartnerApiToken": [] } ], "responses": { "204": { "description": "successful" }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "404": { "description": "not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } } }, "get": { "summary": "Find webhook by ID", "tags": [ "Webhooks" ], "description": "Returns a webhook with specific ID
Required scopes: administration", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "administration" ] }, { "PartnerApiToken": [] } ], "responses": { "200": { "description": "successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "404": { "description": "not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } } }, "put": { "summary": "Update webhook", "tags": [ "Webhooks" ], "description": "Updates a webhook
Required scopes: administration", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "security": [ { "OAuth2": [ "administration" ] }, { "PartnerApiToken": [] } ], "responses": { "200": { "description": "successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } } }, "401": { "description": "unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "403": { "description": "forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "404": { "description": "not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } }, "422": { "description": "unprocessable entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/errors_object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/new_or_update_webhook" } } }, "required": true, "description": "Updated webhook attributes" } } } }, "servers": [ { "url": "https://api.contentsnare.com", "description": "Content Snare Partner API" } ], "components": { "securitySchemes": { "OAuth2": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "/oauth/authorization", "tokenUrl": "/oauth/token", "scopes": { "read_clients": "Read Clients", "write_clients": "Create/Update/Delete Clients", "read_team_members": "Read Team Members", "write_team_members": "Create/Update/Delete Team Members", "read_requests": "Read Requests", "write_requests": "Create/Update/Delete Requests", "review_requests": "Review Request Answers", "read_templates": "Read Templates", "read": "Read clients, templates and folders", "write": "Create clients and requests", "administration": "Administration (webhook handling)" } } } }, "PartnerApiToken": { "type": "http", "scheme": "bearer", "bearerFormat": "Personal access token (cs_pat_)", "description": "Personal access token for one member in one company. Generate it in [Personal access tokens](https://app.contentsnare.com/settings/security/access-tokens). Enter the complete cs_pat_ token without the Bearer prefix. Each endpoint requires the documented scopes and current member permissions." } }, "schemas": { "webhook_payloads": { "error_messages": { "type": "array", "description": "Error messages", "items": { "type": "string", "example": "First error message example" } }, "page": { "type": "object", "properties": { "id": { "type": "string", "description": "Page id", "example": "pag_eOBovevhMyqPM5" }, "name": { "type": "string", "description": "Page name. If it isn't set then the source template name is used.", "example": "Page 1" }, "instruction_text": { "type": "string", "description": "Page instruction text", "example": "
Hi!
The goal of this page is to tell ...
" }, "fields_count": { "type": "string", "description": "The number of fields present on the request", "example": 17 }, "toc_order_label": { "type": "string", "example": "2.0" }, "reference_id": { "type": "string", "example": "rpag_eOBovevhMyqPM5", "description": "A reference ID is an identifier, unique within a request, that remains consistent across all instances of a page in multiple requests and request templates" }, "sections": { "type": "array", "items": { "$ref": "#/components/schemas/webhook_payloads/section" } } } }, "section": { "type": "object", "properties": { "id": { "type": "string", "description": "Section id", "example": "sec_WBkg4PxC7agM0P" }, "name": { "type": "string", "description": "Section name. If it isn't set then the source template name is used.", "example": "Section 1" }, "instruction_text": { "type": "string", "description": "Section instruction text", "example": "
Hi!
The goal of this section is to tell ...
" }, "fields_count": { "type": "string", "description": "The number of fields present on the request", "example": 17 }, "hidden": { "type": "boolean", "description": "A boolean value indicating whether the section is hidden or not", "example": false }, "toc_order_label": { "type": "string", "description": "The label used for the Table of Contents (TOC) order", "example": "2.1" }, "reference_id": { "type": "string", "example": "rsec_YlVGMK1svdga0D", "description": "A reference ID is an identifier, unique within a page, that remains consistent across all instances of a section, whether in multiple requests or within duplicated pages of the same request" }, "page_reference_id": { "type": "string", "example": "rpag_eOBovevhMyqPM5", "description": "A page reference ID is an identifier, unique within a request, that remains consistent across all instances of a page in multiple requests and request templates" }, "fields": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/webhook_payloads/field_without_status" }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "approved", "redo", "done", "todo" ], "example": "redo" } } } ] } } } }, "field_without_status": { "properties": { "id": { "type": "string", "description": "Field id", "example": "fld_1lqbwY6TaMPmAo" }, "name": { "type": "string", "description": "Field name", "example": "Text Field 1" }, "instruction_text": { "type": "string", "description": "Field instruction text", "example": "
Field instruction
" }, "hidden": { "type": "boolean", "description": "A boolean value indicating whether the field is hidden or not", "example": false }, "repeater_enabled": { "type": "boolean", "description": "A boolean value indicating if the field allows repetition", "example": true }, "required": { "type": "boolean", "description": "A boolean value specifying whether the field is mandatory", "example": false }, "type": { "type": "string", "description": "Field type", "enum": [ "abr verification", "address", "button", "calendly", "checkbox", "color picker", "country select", "currency", "date range", "date/time", "email", "file", "icon", "image", "image select", "number", "numeric rating", "phone", "radio", "select", "signature", "slider", "star rating", "table", "task list", "text", "textarea", "url", "verification", "wysiwyg" ], "example": "text" }, "values": { "type": "array", "description": "An array of strings representing possible values for the field", "items": { "type": "string", "example": "Example completed field answer" } }, "values_flat": { "type": "string", "description": "A string containing values from the \"values\" array in a flattened format", "example": "Example completed field answer" }, "values_structured": { "$ref": "#/components/schemas/field_values_structured" }, "confidential": { "type": "boolean", "description": "A boolean value indicating if the field data is confidential", "example": false }, "section_id": { "type": "string", "description": "Section id", "example": "sec_WBkg4PxC7agM0P" }, "page_id": { "type": "string", "description": "Page id", "example": "pag_eOBovevhMyqPM5" }, "reference_id": { "type": "string", "example": "rfld_1lqbwY6TaMPmAo", "description": "A reference ID is an identifier, unique within a section, that remains consistent across all instances of a field, whether in multiple requests or within repeated sections of the same request" }, "section_reference_id": { "type": "string", "example": "rsec_WBkg4PxC7agM0P", "description": "A section reference ID is an identifier, unique within a page, that remains consistent across all instances of a section, whether in multiple requests or within duplicated pages of the same request" }, "page_reference_id": { "type": "string", "example": "rpag_eOBovevhMyqPM5", "description": "A page reference ID is an identifier, unique within a request, that remains consistent across all instances of a page in multiple requests and request templates" }, "section_name": { "type": "string", "description": "The name of the section to which the field belongs", "example": "Section 1" }, "page_name": { "type": "string", "description": "The name of the page where the field is located", "example": "Page 1" } } }, "field_with_request": { "allOf": [ { "$ref": "#/components/schemas/webhook_payloads/field_without_status" }, { "type": "object", "properties": { "request": { "allOf": [ { "$ref": "#/components/schemas/webhook_payloads/request_base_attrs" }, { "$ref": "#/components/schemas/webhook_payloads/request_client_present" } ] } } } ] }, "comment_base_attrs": { "type": "object", "properties": { "id": { "type": "string", "description": "Comment id", "example": "com_BErwx9AsZR4AmW" }, "answer_id": { "type": [ "string", "null" ], "description": "Answer id", "example": "ans_MyVzlOBfKGBaGl" }, "field_id": { "type": "string", "description": "Filed id", "example": "fld_WGN31knSwmKe6X" }, "section_id": { "type": "string", "description": "Section id", "example": "sec_jLEQJK5s47gpR4" }, "tab_id": { "type": "string", "description": "Page id", "example": "pag_eOBovevhYpqPM5" }, "request_id": { "type": "string", "description": "Request id", "example": "req_7v80jRXCo90mAo" }, "text": { "type": "string", "description": "A string containing the actual text content of the comment", "example": "Test Comment" }, "type": { "type": "string", "description": "A string specifying the type of the comment", "example": "user", "enum": [ "user", "outstanding", "complete", "approve", "not_complete", "deleted", "approval_removed", "internal", "deleted_internal" ] }, "unread": { "type": "boolean", "description": "A boolean value indicating whether the comment is marked as unread", "example": true }, "created_at": { "type": "string", "description": "A string showing the timestamp when the comment was created", "example": "2024-04-22T13:58:11.929Z" }, "updated_at": { "type": "string", "description": "A string displaying the timestamp when the comment was last updated", "example": "2024-04-22T13:58:11.929Z" }, "reference_meta": { "description": "An object that can potentially store additional metadata related to the comment", "type": "object" }, "account": { "type": "object", "description": "An object representing either a client or a team member associated with the comment", "properties": { "id": { "type": "string", "description": "Account id", "example": "acc_e7EVAXvJfxZ9zb" }, "first_name": { "type": "string", "description": "Contact first name", "example": "Keva" }, "full_name": { "type": "string", "description": "Contact full name", "example": "Keva Ryan" }, "last_name": { "type": "string", "description": "Contact last name", "example": "Ryan" }, "email": { "type": "string", "description": "Contact email address", "example": "keva.ryan@stark.ca" }, "salutation": { "type": [ "string", "null" ], "description": "Salutation (e.g. Mr, Mrs, Dr)", "example": "Dr" }, "timezone": { "type": "string", "description": "Timezone", "example": "Australia/Brisbane" }, "avatar": { "type": "string", "description": "A string containing the URL or path to the avatar image of the account user", "example": "https://example.com/user_avatar.jpeg" }, "company_name": { "type": "string", "description": "Company name", "example": "Stark Enterprises" }, "date_format": { "type": "string", "description": "Date format", "example": "MM-dd-yyyy" }, "language_code": { "type": "string", "description": "Language code", "example": "en" }, "client_company": { "$ref": "#/components/schemas/webhook_payloads/client_company" } } } } }, "identity_product": { "type": "string", "description": "The name or identifier of the product item", "example": "identityverification", "default": "identityverification" }, "identity_product_item_purchase_attrs": { "type": "object", "properties": { "id": { "type": "string", "description": "Product item id", "example": "pmt_1pGbLE7Clr3On6" }, "quantity": { "type": "integer", "description": "The quantity of the product item", "minimum": 5, "maximum": 100, "example": 10 }, "invoice": { "type": "string", "description": "Invoice number associated with the product item", "example": "CS-7523" }, "product": { "$ref": "#/components/schemas/webhook_payloads/identity_product" } } }, "identity_product_item_attrs": { "type": "object", "properties": { "id": { "type": "string", "description": "Product item id", "example": "vss_O6oWgeQaIOgXE0" }, "client_full_name": { "type": "string", "description": "Client full name", "example": "Keva Ryan" }, "client_email": { "type": "string", "description": "Client email", "example": "keva.ryan@stark.ca" }, "request_name": { "type": "string", "description": "Request name", "example": "Website Page Information" }, "product": { "$ref": "#/components/schemas/webhook_payloads/identity_product" }, "request_id": { "type": "string", "description": "Request id", "example": "req_7v80jRXC4M0mAo" }, "page_id": { "type": "string", "description": "Page id", "example": "pag_XQL19kKu5xo2YP" }, "section_id": { "type": "string", "description": "Section id", "example": "sec_yO4No1PU36Qd6Z" }, "field_id": { "type": "string", "description": "Field id", "example": "fld_1lqbwY6TXM6PmA" }, "account_id": { "type": "string", "description": "Client id", "example": "acc_vK7Zym9U35Z69l" } } }, "integration_action": { "type": "object", "properties": { "id": { "type": "string", "description": "Integration action id", "example": "iac_xNQwbKA5IyoOEq" }, "action_type": { "type": "string", "description": "Action type", "example": "create_client", "enum": [ "create_client" ] }, "integration_name": { "type": "string", "description": "Integration name", "example": "xpm", "enum": [ "xpm" ] }, "request_id": { "type": "string", "description": "Request id", "example": "req_1k7zv4aUlpN8PB" }, "request_name": { "type": "string", "description": "Request name", "example": "Request 1" }, "page_id": { "type": "string", "description": "Id of the page to which the integration action is assigned. It's null if `section_id`, `section_name` are filled.", "example": "pag_jAxqEgBi4prM6g" }, "page_name": { "type": "string", "description": "Name of the page to which the integration action is assigned. It's null if `section_id`, `section_name` are filled.", "example": "Page 1" }, "section_id": { "type": "string", "description": "Id of the section to which the integration action is assigned. It's null if `page_id`, `page_name` are filled.", "example": null }, "section_name": { "type": "string", "description": "Id of the section to which the integration action is assigned. It's null if `page_id`, `page_name` are filled.", "example": null } } }, "client_in_request": { "type": "object", "properties": { "avatar": { "type": "string", "description": "A string containing the URL or path to the avatar image of the account user", "example": "https://example.com/user_avatar.jpeg" }, "company_name": { "type": "string", "description": "If this company name is not already associated with this client, it will be created.", "example": "Stark Enterprises" }, "email": { "type": "string", "description": "Contact email address", "example": "keva.ryan@stark.ca" }, "first_name": { "type": "string", "description": "Contact first name", "example": "Keva" }, "full_name": { "type": "string", "description": "Contact full name", "example": "Keva Ryan" }, "id": { "type": "string", "description": "Client id", "example": "acc_MORVw9Cyq97AyN" }, "last_name": { "type": "string", "description": "Contact last name", "example": "Ryan" }, "phone": { "type": "string", "description": "Phone number", "example": "+1 (415) 555-1212" }, "salutation": { "type": [ "string", "null" ], "description": "Salutation (e.g. Mr, Mrs, Dr)", "example": "Dr" }, "url": { "type": "string", "description": "Client access link", "example": "https://webcorp.contentsnare.com/shared/b5cd2ffc-b290-40ff-bea9-adea3dc1994b" } } }, "client_in_sms_and_email_attrs": { "type": "object", "properties": { "id": { "type": "string", "description": "Client id", "example": "acc_MORVw9Cyq97AyN" }, "first_name": { "type": "string", "description": "Contact first name", "example": "Keva" }, "full_name": { "type": "string", "description": "Contact full name", "example": "Keva Ryan" }, "last_name": { "type": "string", "description": "Contact last name", "example": "Ryan" }, "email": { "type": "string", "description": "Contact email address", "example": "keva.ryan@stark.ca" }, "salutation": { "type": [ "string", "null" ], "description": "Salutation (e.g. Mr, Mrs, Dr)", "example": "Dr" }, "timezone": { "type": "string", "description": "Timezone", "example": "Asia/Manila" }, "avatar": { "type": "string", "description": "A string containing the URL or path to the avatar image of the account user", "example": "https://example.com/user_avatar.jpeg" }, "company_name": { "type": "string", "description": "If this company name is not already associated with this client, it will be created.", "example": "Stark Enterprises" }, "date_format": { "type": "string", "description": "Date format", "example": "MM/dd/yyyy" }, "language_code": { "type": "string", "description": "Language code", "example": "en" }, "client_company": { "$ref": "#/components/schemas/webhook_payloads/client_company" } } }, "client_company": { "type": "object", "properties": { "id": { "type": "string", "description": "Client company id", "example": "cmp_z105QJxhy7YdlX" }, "name": { "type": "string", "description": "The name of the client company", "example": "Trantow LLC" }, "avatar_url": { "type": "string", "description": "The URL pointing to the avatar or logo of the client company", "example": "https://example.com/user_avatar.jpeg" } } }, "recurring_request": { "type": "object", "properties": { "id": { "type": "string", "description": "Recurring request id", "example": "rfr_ZR6wa50lC5qQk3" }, "name": { "type": "string", "description": "Recurring request name", "example": "Recurring Request Name" } } }, "request_base_attrs": { "type": "object", "properties": { "id": { "type": "string", "description": "Request id", "example": "req_1k7zv4aUlpN8PB" }, "name": { "type": "string", "description": "Request name", "example": "Request 1" }, "wildcards": { "type": "object", "description": "Every supported instruction tag with its value for this request, keyed by the bare tag name. Values are raw text; sanitise them before you place them into HTML. A tag with nothing to resolve from has an empty value. The `clients.*` tags hold a list of strings, one per client, primary first. Join it in the viewer's language. The list is empty when nothing resolves it.\n", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "example": { "client.contact_first_name": "Fred", "client.company_name": "Smith & Sons", "clients.contact_first_name": [ "Fred", "Sam" ], "request.name": "Request 1" } }, "url": { "type": "string", "description": "Link to a specific request in the system", "example": "https://webcorp.contentsnare.com/requests/143" }, "due": { "type": "string", "description": "Due date for the request.
Format: yyyy-mm-dd", "default": "in 2 weeks", "example": "2024-08-15" }, "expires_after_due": { "type": "boolean", "description": "When true, the request is closed once the due date passes — it moves to the completed status with an expiry timestamp, and the client loses access. The request itself stays available to your team, and publishing it again with a later due date reopens it.", "example": false }, "folder_name": { "type": "string", "description": "Folder name. Requests may be grouped in to folders on the requests page. Don't send it if you do not wish to group your Requests.", "default": "Default Folder", "example": "Folder 1" }, "passcode_enabled": { "type": "boolean", "description": "Protect share with a pin code. Your client will be asked to set their own pincode when they first access the request.", "default": false, "example": false }, "share_link": { "type": "string", "example": "https://webcorp.contentsnare.com/shared/6981788b-ce73-4bd6-985d-4eceec055ef9", "description": "URL link for share the request" }, "share_via_link_enabled": { "type": "boolean", "description": "Allow share via link without requiring login", "default": false, "example": true }, "communication_template_name": { "type": "string", "description": "Name of communications schedule", "example": "Schedule name" }, "completion_percentage": { "type": "integer", "example": 65, "description": "Completion percentage, shows how much of the request is filled out" }, "comments_enabled": { "type": "boolean", "description": "Enable client comments. This allows your client to ask questions about each field.", "example": true }, "request_template_name": { "type": "string", "description": "Request template name (`request_template_id` or `request_template_name` should be set)", "example": "Request Template 1" }, "owner_name": { "type": "string", "description": "Request owner (team member) name", "example": "Julian Skiles" }, "author_name": { "type": [ "string", "null" ], "description": "Request author (team member) name", "example": "Laurence Bosco" }, "client_status": { "type": [ "string", "null" ], "example": "existing" }, "due_date": { "type": "string", "description": "Due date for the request.
Format: yyyy-mm-dd", "default": "in 2 weeks", "example": "2024-08-15" }, "pin_code_enabled": { "type": "boolean", "example": true } } }, "request_client_present": { "type": "object", "properties": { "client": { "$ref": "#/components/schemas/webhook_payloads/client_in_request" }, "clients": { "type": "array", "items": { "$ref": "#/components/schemas/webhook_payloads/client_in_request" } } } }, "request_with_clients": { "allOf": [ { "$ref": "#/components/schemas/webhook_payloads/request_base_attrs" }, { "$ref": "#/components/schemas/webhook_payloads/request_client_present" } ] }, "request_with_clients_and_pages": { "allOf": [ { "$ref": "#/components/schemas/webhook_payloads/request_base_attrs" }, { "$ref": "#/components/schemas/webhook_payloads/request_client_present" }, { "type": "object", "properties": { "pages": { "type": "array", "items": { "$ref": "#/components/schemas/webhook_payloads/page" } } } } ] }, "request_board_column": { "type": "object", "properties": { "id": { "type": "string", "example": "bcl_5PZ0jQpZT1ORde" }, "name": { "type": "string", "example": "Under Review" }, "protected": { "type": "boolean", "example": false }, "sorting_position": { "type": "integer", "example": 1 } } }, "client_base_attrs": { "type": "object", "properties": { "id": { "type": "string", "description": "Client id", "example": "acc_MORVw9Cyq97AyN" }, "date_format": { "type": "string", "description": "Date format", "example": "MM/dd/yyyy" }, "email": { "type": "string", "description": "Contact email address", "example": "keva.ryan@stark.ca" }, "first_name": { "type": "string", "description": "Contact first name", "example": "Keva" }, "full_name": { "type": "string", "description": "Contact full name", "example": "Keva Ryan" }, "last_name": { "type": "string", "description": "Contact last name", "example": "Ryan" }, "language_code": { "type": "string", "description": "Language code", "example": "en" }, "phone": { "type": "string", "description": "Phone number", "example": "+1 (415) 555-1212" }, "salutation": { "type": [ "string", "null" ], "description": "Salutation (e.g. Mr, Mrs, Dr)", "example": "Dr" }, "timezone": { "type": "string", "description": "Timezone", "example": "Asia/Manila" }, "avatar": { "type": [ "string", "null" ], "description": "A string containing the URL or path to the avatar image of the account user", "example": "https://example.com/user_avatar.jpeg" }, "archived": { "type": "boolean", "description": "A boolean value indicating whether the client is archived or not", "example": false }, "is_assigned": { "type": "boolean", "description": "A boolean value indicating whether the client is currently assigned or not", "example": true }, "client_companies": { "type": "array", "items": { "$ref": "#/components/schemas/webhook_payloads/client_company" } } } }, "client_with_errors": { "allOf": [ { "$ref": "#/components/schemas/webhook_payloads/client_base_attrs" }, { "type": "object", "properties": { "errors": { "$ref": "#/components/schemas/webhook_payloads/error_messages" } } } ] }, "team_member_base_attrs": { "type": "object", "properties": { "id": { "type": "string", "description": "Team member id", "example": "acc_MORVw9Cyq97AyN" }, "date_format": { "type": "string", "description": "Date format", "example": "MM/dd/yyyy" }, "email": { "type": "string", "description": "Contact email address", "example": "keva.ryan@stark.ca" }, "first_name": { "type": "string", "description": "Contact first name", "example": "Keva" }, "full_name": { "type": "string", "description": "Contact full name", "example": "Keva Ryan" }, "last_name": { "type": "string", "description": "Contact last name", "example": "Ryan" }, "language_code": { "type": "string", "description": "Language code", "example": "en" }, "phone": { "type": "string", "description": "Phone number", "example": "+1 (415) 555-1212" }, "salutation": { "type": [ "string", "null" ], "description": "Salutation (e.g. Mr, Mrs, Dr)", "example": "Dr" }, "timezone": { "type": "string", "description": "Timezone", "example": "Asia/Manila" }, "avatar": { "type": [ "string", "null" ], "description": "Team member avatar", "example": "https://example.com/user_avatar.jpeg" } } }, "team_member_with_errors": { "allOf": [ { "$ref": "#/components/schemas/webhook_payloads/team_member_base_attrs" }, { "type": "object", "properties": { "errors": { "$ref": "#/components/schemas/webhook_payloads/error_messages" } } } ] }, "recurring_request_created": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "recurring_request_created", "default": "recurring_request_created" } } }, { "$ref": "#/components/schemas/webhook_payloads/recurring_request" } ] }, "recurring_request_destroyed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "recurring_request_destroyed", "default": "recurring_request_destroyed" } } }, { "$ref": "#/components/schemas/webhook_payloads/recurring_request" } ] }, "recurring_request_executed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "recurring_request_executed", "default": "recurring_request_executed" } } }, { "$ref": "#/components/schemas/webhook_payloads/recurring_request" } ] }, "recurring_request_completed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "recurring_request_completed", "default": "recurring_request_completed" } } }, { "$ref": "#/components/schemas/webhook_payloads/recurring_request" } ] }, "recurring_request_failed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "recurring_request_failed", "default": "recurring_request_failed" } } }, { "$ref": "#/components/schemas/webhook_payloads/recurring_request" }, { "type": "object", "properties": { "errors": { "$ref": "#/components/schemas/webhook_payloads/error_messages" } } } ] }, "request_created": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "request_created", "default": "request_created" }, "status": { "type": "string", "description": "Request status", "default": "draft", "example": "published", "enum": [ "published", "draft" ] } } }, { "$ref": "#/components/schemas/webhook_payloads/request_with_clients" } ] }, "request_updated": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "request_updated", "default": "request_updated" }, "status": { "type": "string", "description": "Request status", "example": "published", "enum": [ "draft", "published", "completed", "archived", "scheduled", "waiting", "expired" ] } } }, { "$ref": "#/components/schemas/webhook_payloads/request_with_clients" } ] }, "request_published": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "request_published", "default": "request_published" }, "status": { "type": "string", "description": "Request status", "example": "published", "default": "published" } } }, { "$ref": "#/components/schemas/webhook_payloads/request_with_clients_and_pages" } ] }, "request_completed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "request_completed", "default": "request_completed" }, "status": { "type": "string", "description": "Request status", "example": "completed", "default": "completed" } } }, { "$ref": "#/components/schemas/webhook_payloads/request_with_clients_and_pages" } ] }, "request_archived": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "request_archived", "default": "request_archived" }, "status": { "type": "string", "description": "Request status", "example": "archived", "default": "archived" } } }, { "$ref": "#/components/schemas/webhook_payloads/request_with_clients_and_pages" } ] }, "request_destroyed": { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "request_destroyed", "default": "request_destroyed" }, "id": { "type": "string", "description": "Request id", "example": "req_1k7zv4aUlpN8PB" } } }, "request_board_column_changed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "request_board_column_changed", "default": "request_board_column_changed" }, "status": { "type": "string", "description": "Request status", "example": "published", "enum": [ "draft", "published", "completed", "archived", "scheduled", "waiting", "expired" ] } } }, { "$ref": "#/components/schemas/webhook_payloads/request_with_clients" }, { "type": "object", "properties": { "board_column": { "$ref": "#/components/schemas/webhook_payloads/request_board_column" }, "board_column_attrs": { "$ref": "#/components/schemas/webhook_payloads/request_board_column" } } } ] }, "request_waiting_for_approval": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "request_waiting_for_approval", "default": "request_waiting_for_approval" }, "status": { "type": "string", "description": "Request status", "example": "completed", "default": "completed" } } }, { "$ref": "#/components/schemas/webhook_payloads/request_with_clients_and_pages" } ] }, "request_expired": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "request_expired", "default": "request_expired" }, "status": { "type": "string", "description": "Request status", "example": "expired", "default": "expired" } } }, { "$ref": "#/components/schemas/webhook_payloads/request_with_clients_and_pages" } ] }, "request_owner_reassigned": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "request_owner_reassigned", "default": "request_owner_reassigned" } } }, { "$ref": "#/components/schemas/webhook_payloads/request_with_clients" } ] }, "request_viewed": { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "request_viewed" }, "id": { "type": "string", "example": "evt_WlG8EaphWK8rxv" }, "request_id": { "type": "string", "example": "req_1k7zv4aUlpN8PB" }, "account_id": { "type": "string", "example": "acc_MORVw9Cyq97AyN" }, "event_type": { "type": "string", "example": "actions" }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "example": "New Request" } } }, "client": { "type": "object", "properties": { "id": { "type": "string", "description": "Client id", "example": "acc_MORVw9Cyq97AyN" }, "full_name": { "type": "string", "description": "Contact full name", "example": "Keva Ryan" }, "email": { "type": "string", "description": "Contact email address", "example": "keva.ryan@stark.ca" }, "timezone": { "type": "string", "description": "Timezone", "example": "Asia/Manila" }, "avatar": { "type": "string", "description": "A string containing the URL or path to the avatar image of the account user", "example": "https://example.com/user_avatar.jpeg" }, "company_name": { "type": "string", "description": "If this company name is not already associated with this client, it will be created.", "example": "Stark Enterprises" }, "date_format": { "type": "string", "description": "Date format", "example": "MM/dd/yyyy" } } }, "client_company": { "$ref": "#/components/schemas/webhook_payloads/client_company" }, "request": { "$ref": "#/components/schemas/webhook_payloads/request_base_attrs" } } }, "request_exported": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "request_exported", "default": "request_exported" }, "status": { "type": "string", "description": "Request status", "example": "published", "default": "published" } } }, { "$ref": "#/components/schemas/webhook_payloads/request_with_clients" } ] }, "request_draft": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "request_draft", "default": "request_draft" }, "status": { "type": "string", "description": "Request status", "example": "draft" } } }, { "$ref": "#/components/schemas/webhook_payloads/request_with_clients" } ] }, "request_scheduled": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "request_scheduled", "default": "request_scheduled" }, "status": { "type": "string", "description": "Request status", "example": "scheduled", "default": "scheduled" } } }, { "$ref": "#/components/schemas/webhook_payloads/request_with_clients_and_pages" } ] }, "request_create_failed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "request_create_failed", "default": "request_create_failed" }, "status": { "type": "string", "description": "Request status", "example": "draft" }, "errors": { "$ref": "#/components/schemas/webhook_payloads/error_messages" } } }, { "$ref": "#/components/schemas/webhook_payloads/request_with_clients" } ] }, "request_update_failed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "request_update_failed", "default": "request_update_failed" }, "status": { "type": "string", "description": "Request status", "example": "draft", "enum": [ "draft", "published", "completed", "archived", "scheduled", "waiting", "expired" ] }, "errors": { "$ref": "#/components/schemas/webhook_payloads/error_messages" } } }, { "$ref": "#/components/schemas/webhook_payloads/request_with_clients" } ] }, "request_destroy_failed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "request_destroy_failed", "default": "request_destroy_failed" }, "status": { "type": "string", "description": "Request status", "example": "draft", "enum": [ "draft", "published", "completed", "archived", "scheduled", "waiting", "expired" ] }, "errors": { "$ref": "#/components/schemas/webhook_payloads/error_messages" } } }, { "$ref": "#/components/schemas/webhook_payloads/request_with_clients" } ] }, "request_published_failed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "request_published_failed", "default": "request_published_failed" }, "status": { "type": "string", "description": "Request status", "example": "draft" }, "errors": { "$ref": "#/components/schemas/webhook_payloads/error_messages" } } }, { "$ref": "#/components/schemas/webhook_payloads/request_with_clients" } ] }, "request_completed_failed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "request_completed_failed", "default": "request_completed_failed" }, "status": { "type": "string", "description": "Request status", "example": "published" }, "errors": { "$ref": "#/components/schemas/webhook_payloads/error_messages" } } }, { "$ref": "#/components/schemas/webhook_payloads/request_with_clients" } ] }, "request_archived_failed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "request_archived_failed", "default": "request_archived_failed" }, "status": { "type": "string", "description": "Request status", "example": "completed", "enum": [ "draft", "published", "completed", "archived", "scheduled", "waiting", "expired" ] }, "errors": { "$ref": "#/components/schemas/webhook_payloads/error_messages" } } }, { "$ref": "#/components/schemas/webhook_payloads/request_with_clients" } ] }, "request_board_column_change_failed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "request_board_column_change_failed", "default": "request_board_column_change_failed" }, "status": { "type": "string", "description": "Request status", "example": "completed", "enum": [ "draft", "published", "completed", "archived", "scheduled", "waiting", "expired" ] }, "errors": { "$ref": "#/components/schemas/webhook_payloads/error_messages" } } }, { "$ref": "#/components/schemas/webhook_payloads/request_with_clients" } ] }, "scheduled_request_failed_to_publish": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "scheduled_request_failed_to_publish", "default": "scheduled_request_failed_to_publish" }, "status": { "type": "string", "description": "Request status", "example": "scheduled" }, "errors": { "type": "array", "description": "Error messages", "items": { "type": "string", "example": "Request Failed To Publish" } } } }, { "$ref": "#/components/schemas/webhook_payloads/request_with_clients" } ] }, "scheduled_request_published_but_limits_exceeded": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "scheduled_request_published_but_limits_exceeded", "default": "scheduled_request_published_but_limits_exceeded" }, "status": { "type": "string", "description": "Request status", "example": "scheduled" }, "errors": { "type": "array", "description": "Error messages", "items": { "type": "string", "example": "Request Published But Limits Exceeded" } } } }, { "$ref": "#/components/schemas/webhook_payloads/request_with_clients" } ] }, "page_completed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "page_completed", "default": "page_completed" } } }, { "$ref": "#/components/schemas/webhook_payloads/page" }, { "type": "object", "properties": { "request": { "allOf": [ { "$ref": "#/components/schemas/webhook_payloads/request_base_attrs" }, { "$ref": "#/components/schemas/webhook_payloads/request_client_present" } ] } } } ] }, "section_completed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "section_completed", "default": "section_completed" } } }, { "$ref": "#/components/schemas/webhook_payloads/section" }, { "type": "object", "properties": { "page_name": { "type": "string", "description": "The name of the page where the field is located", "example": "Page 1" }, "page_id": { "type": "string", "description": "Id of a page where a new section should be added", "example": "pag_eOBovevhMyqPM5" } } }, { "type": "object", "properties": { "request": { "allOf": [ { "$ref": "#/components/schemas/webhook_payloads/request_base_attrs" }, { "$ref": "#/components/schemas/webhook_payloads/request_client_present" } ] } } } ] }, "client_created": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "client_created", "default": "client_created" } } }, { "$ref": "#/components/schemas/webhook_payloads/client_base_attrs" } ] }, "client_updated": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "client_updated", "default": "client_updated" } } }, { "$ref": "#/components/schemas/webhook_payloads/client_base_attrs" } ] }, "client_destroyed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "client_destroyed", "default": "client_destroyed" }, "id": { "type": "string", "description": "Client id", "example": "acc_MORVw9Cyq97AyN" } } } ] }, "client_create_failed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "client_create_failed", "default": "client_create_failed" } } }, { "$ref": "#/components/schemas/webhook_payloads/client_with_errors" } ] }, "client_update_failed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "client_update_failed", "default": "client_update_failed" } } }, { "$ref": "#/components/schemas/webhook_payloads/client_with_errors" } ] }, "client_destroy_failed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "client_destroy_failed", "default": "client_destroy_failed" } } }, { "$ref": "#/components/schemas/webhook_payloads/client_with_errors" } ] }, "team_member_created": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "team_member_created", "default": "team_member_created" } } }, { "$ref": "#/components/schemas/webhook_payloads/team_member_base_attrs" } ] }, "team_member_updated": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "team_member_updated", "default": "team_member_updated" } } }, { "$ref": "#/components/schemas/webhook_payloads/team_member_base_attrs" } ] }, "team_member_destroyed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "team_member_destroyed", "default": "team_member_destroyed" }, "id": { "type": "string", "description": "Team member id", "example": "acc_MORVw9Cyq97AyN" } } } ] }, "team_member_create_failed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "team_member_create_failed", "default": "team_member_create_failed" } } }, { "$ref": "#/components/schemas/webhook_payloads/team_member_with_errors" } ] }, "team_member_update_failed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "team_member_update_failed", "default": "team_member_update_failed" } } }, { "$ref": "#/components/schemas/webhook_payloads/team_member_with_errors" } ] }, "team_member_destroy_failed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "team_member_destroy_failed", "default": "team_member_destroy_failed" } } }, { "$ref": "#/components/schemas/webhook_payloads/team_member_with_errors" } ] }, "field_completed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "field_completed", "default": "field_completed" }, "status": { "type": "string", "example": "done", "default": "done" } } }, { "$ref": "#/components/schemas/webhook_payloads/field_with_request" } ] }, "field_approved": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "field_approved", "default": "field_approved" }, "status": { "type": "string", "example": "approved", "default": "approved" } } }, { "$ref": "#/components/schemas/webhook_payloads/field_with_request" } ] }, "field_rejected": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "field_rejected", "default": "field_rejected" }, "status": { "type": "string", "example": "redo", "default": "redo" } } }, { "$ref": "#/components/schemas/webhook_payloads/field_with_request" } ] }, "signature_completed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "signature_completed", "default": "signature_completed" }, "status": { "type": "string", "example": "done", "default": "done" } } }, { "$ref": "#/components/schemas/webhook_payloads/field_with_request" } ] }, "all_fields_completed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "all_fields_completed", "default": "all_fields_completed" }, "request": { "allOf": [ { "type": "object", "properties": { "status": { "type": "string", "description": "Request status", "example": "published", "default": "published" } } }, { "$ref": "#/components/schemas/webhook_payloads/request_with_clients_and_pages" } ] } } } ] }, "comment_created": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "comment_created", "default": "comment_created" } } }, { "$ref": "#/components/schemas/webhook_payloads/comment_base_attrs" } ] }, "internal_comment_created": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "internal_comment_created", "default": "internal_comment_created" } } }, { "$ref": "#/components/schemas/webhook_payloads/comment_base_attrs" } ] }, "comment_create_failed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "comment_create_failed", "default": "comment_create_failed" } } }, { "$ref": "#/components/schemas/webhook_payloads/comment_base_attrs" }, { "type": "object", "properties": { "errors": { "$ref": "#/components/schemas/webhook_payloads/error_messages" } } } ] }, "product_item_manual_purchase": { "allOf": [ { "$ref": "#/components/schemas/webhook_payloads/identity_product_item_purchase_attrs" }, { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "product_item_manual_purchase", "default": "product_item_manual_purchase" }, "status": { "type": "string", "description": "The current status of the product item", "example": "paid", "default": "paid" }, "account_id": { "type": "string", "description": "Client id", "example": "acc_e7EVAXvJfxZ9zb" }, "payment_initiator": { "type": "string", "description": "The entity initiating the payment for the product item.
customer: Represents that the payment was initiated by the customer.
merchant: Represents that the payment was initiated by the merchant.", "example": "customer", "default": "customer" } } } ] }, "product_item_auto_purchase": { "allOf": [ { "$ref": "#/components/schemas/webhook_payloads/identity_product_item_purchase_attrs" }, { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "product_item_auto_purchase", "default": "product_item_auto_purchase" }, "status": { "type": "string", "description": "The current status of the product item", "example": "paid", "default": "paid" }, "payment_initiator": { "type": "string", "description": "The entity initiating the payment for the product item.
customer: Represents that the payment was initiated by the customer.
merchant: Represents that the payment was initiated by the merchant.", "example": "merchant", "default": "merchant" } } } ] }, "product_item_purchase_failed": { "allOf": [ { "$ref": "#/components/schemas/webhook_payloads/identity_product_item_purchase_attrs" }, { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "product_item_purchase_failed", "default": "product_item_purchase_failed" }, "status": { "type": "string", "description": "The current status of the product item", "example": "not_paid", "default": "not_paid" }, "payment_initiator": { "type": "string", "description": "The entity initiating the payment for the product item.
customer: Represents that the payment was initiated by the customer.
merchant: Represents that the payment was initiated by the merchant.", "example": "merchant", "enum": [ "customer", "merchant" ] }, "error_messages": { "type": "string", "description": "Error messages", "example": "Invoice cannot be created as the payment collection failed. Gateway Error: Card declined." } } } ] }, "product_item_used": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "product_item_used", "default": "product_item_used" }, "quantity": { "type": "integer", "description": "The quantity of the product item", "example": 1, "default": 1 } } }, { "$ref": "#/components/schemas/webhook_payloads/identity_product_item_attrs" } ] }, "product_item_returned": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "product_item_returned", "default": "product_item_returned" }, "quantity": { "type": "integer", "description": "The quantity of the product item", "example": 1, "default": 1 }, "text": { "type": "string", "description": "A string containing additional information", "example": "Credit returned due to client declining license rights" } } }, { "$ref": "#/components/schemas/webhook_payloads/identity_product_item_attrs" } ] }, "product_item_exhausted": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "product_item_exhausted", "default": "product_item_exhausted" }, "quantity": { "type": "integer", "description": "The quantity of the product item", "example": 0, "default": 0 } } }, { "$ref": "#/components/schemas/webhook_payloads/identity_product_item_attrs" } ] }, "sms_delivered": { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "sms_delivered", "default": "sms_delivered" }, "id": { "type": "string", "example": "evt_pMG8MXNHVMOxAY" }, "request_id": { "type": "string", "example": "req_ZM7zaxKh2jDaEo" }, "account_id": { "type": "string", "example": "acc_7EVAXvJfmrZ9zb" }, "event_type": { "type": "string", "example": "actions", "default": "actions" }, "parameters": { "type": "object", "properties": { "from": { "type": "string", "examples": "+10000000000" }, "phone": { "type": "string", "example": "+10000000000" }, "status": { "type": "string", "example": "sms_delivered" }, "subject": { "type": "string", "example": "Test Message" }, "template_name": { "type": "string", "example": "SMS Test Template" } } }, "request": { "$ref": "#/components/schemas/webhook_payloads/request_base_attrs" }, "client": { "$ref": "#/components/schemas/webhook_payloads/client_in_sms_and_email_attrs" } } }, "sms_failed": { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "sms_failed", "default": "sms_failed" }, "id": { "type": "string", "example": "evt_pMG8MXNHVMOxAY" }, "request_id": { "type": "string", "example": "req_ZM7zaxKh2jDaEo" }, "account_id": { "type": "string", "example": "acc_7EVAXvJfmrZ9zb" }, "event_type": { "type": "string", "example": "critical", "default": "critical" }, "parameters": { "type": "object", "properties": { "from": { "type": "string", "examples": "+10000000000" }, "phone": { "type": "string", "example": "+10000000000" }, "status": { "type": "string", "example": "sms_failed" }, "subject": { "type": "string", "example": "Test Message" }, "template_name": { "type": "string", "example": "SMS Test Template" }, "error_messages": { "type": "array", "items": { "type": "string", "example": "SMS failed error message" } } } }, "request": { "$ref": "#/components/schemas/webhook_payloads/request_base_attrs" }, "client": { "$ref": "#/components/schemas/webhook_payloads/client_in_sms_and_email_attrs" } } }, "email_spam_complained": { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "email_spam_complained", "default": "email_spam_complained" }, "id": { "type": "string", "example": "evt_pMG8MXNHVMOxAY" }, "request_id": { "type": "string", "example": "req_ZM7zaxKh2jDaEo" }, "account_id": { "type": "string", "example": "acc_7EVAXvJfmrZ9zb" }, "event_type": { "type": "string", "example": "warning", "default": "warning" }, "parameters": { "type": "object", "properties": { "from": { "type": "string", "examples": "clayschaden@mail.org" }, "name": { "type": "string", "example": "Spam complaint" }, "email": { "type": "string", "example": "keva.ryan@stark.ca" }, "status": { "type": "string", "example": "email_spam_complained" }, "subject": { "type": "string", "example": "Test Subject" }, "error_messages": { "type": "array", "items": { "type": "string", "example": "The subscriber explicitly marked this message as spam." } } } }, "request": { "$ref": "#/components/schemas/webhook_payloads/request_base_attrs" }, "client": { "$ref": "#/components/schemas/webhook_payloads/client_in_sms_and_email_attrs" } } }, "email_bounced": { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "email_bounced", "default": "email_bounced" }, "id": { "type": "string", "example": "evt_pMG8MXNHVMOxAY" }, "request_id": { "type": "string", "example": "req_ZM7zaxKh2jDaEo" }, "account_id": { "type": "string", "example": "acc_7EVAXvJfmrZ9zb" }, "event_type": { "type": "string", "example": "critical", "default": "critical" }, "parameters": { "type": "object", "properties": { "from": { "type": "string", "examples": "clayschaden@mail.org" }, "email": { "type": "string", "example": "keva.ryan@stark.ca" }, "status": { "type": "string", "example": "email_bounced" }, "subject": { "type": "string", "example": "Test Subject" }, "error_messages": { "type": "array", "items": { "type": "string", "example": "The server was unable to deliver your message (ex: unknown user, mailbox not found)." } } } }, "request": { "$ref": "#/components/schemas/webhook_payloads/request_base_attrs" }, "client": { "$ref": "#/components/schemas/webhook_payloads/client_in_sms_and_email_attrs" } } }, "email_delivered": { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "email_delivered", "default": "email_delivered" }, "id": { "type": "string", "example": "evt_pMG8MXNHVMOxAY" }, "request_id": { "type": "string", "example": "req_ZM7zaxKh2jDaEo" }, "account_id": { "type": "string", "example": "acc_7EVAXvJfmrZ9zb" }, "event_type": { "type": "string", "example": "warning", "default": "warning" }, "parameters": { "type": "object", "properties": { "from": { "type": "string", "examples": "clayschaden@mail.org" }, "email": { "type": "string", "example": "keva.ryan@stark.ca" }, "status": { "type": "string", "example": "email_delivered" }, "subject": { "type": "string", "example": "Test Subject" } } }, "request": { "$ref": "#/components/schemas/webhook_payloads/request_base_attrs" }, "client": { "$ref": "#/components/schemas/webhook_payloads/client_in_sms_and_email_attrs" } } }, "webhook_delivery_failed": { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "webhook_delivery_failed", "default": "webhook_delivery_failed" }, "id": { "type": "string", "description": "Webhook trigger attempt id", "example": "wta_ObV0eNMTPJjNzB" }, "name": { "type": "string", "description": "Name of the event", "example": "request_created" }, "status": { "type": "string", "description": "Indicates the status of the record", "example": "failure" }, "response_status": { "type": "string", "description": "HTTP response status code", "example": "500" }, "headers": { "type": "object", "description": "Headers of the message" }, "body": { "type": "string", "description": "Body of the message", "example": "Retry later" }, "created_at": { "type": "string", "description": "A string showing the timestamp when the webhook was sent", "example": "2024-01-01T00:00:00Z" } } }, "id_verification_completed": { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "id_verification_completed", "default": "id_verification_completed" }, "id": { "type": "string", "description": "Client id", "example": "acc_MORVw9Cyq97AyN" }, "client_name": { "type": "string", "description": "Contact full name", "example": "Keva Ryan" }, "client_email": { "type": "string", "description": "Contact email address", "example": "keva.ryan@stark.ca" }, "system": { "type": "string", "example": "complycube", "enum": [ "stripe", "complycube" ] }, "items": { "type": "array", "items": { "type": "string", "example": "standard_screening_check" } }, "request_name": { "type": [ "string", "null" ], "example": "Onboarding documents" }, "request_id": { "type": [ "string", "null" ], "example": "req_1k7zv4aUlpN8PB" }, "tab_id": { "type": [ "string", "null" ], "example": "pag_jAxqEgBi4prM6g" }, "section_id": { "type": [ "string", "null" ], "example": "sec_YlVGMK1svdga0D" }, "field_id": { "type": [ "string", "null" ], "example": "fld_1lqbwY6TaMPmAo" }, "monitoring_enabled": { "type": "boolean", "example": false }, "checked_at": { "type": [ "string", "null" ], "example": "2025-12-28T11:05:17.950Z" }, "last_recheck_at": { "type": [ "string", "null" ], "example": null }, "outcome": { "type": "string", "description": "The identity verification outcome. Possible values: `attention_required` (the provider flagged the client and it is awaiting human review), `manually_cleared` (a reviewer chose Proceed; previously sent as `reviewed`), `clear` (system auto-pass with no human review), and `manually_declined` (a reviewer chose Don't Proceed).", "example": "clear", "enum": [ "attention_required", "manually_cleared", "clear", "manually_declined" ] } } }, "id_verification_monitoring_updated": { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "id_verification_monitoring_updated", "default": "id_verification_monitoring_updated" }, "id": { "type": "string", "description": "Client id", "example": "acc_MORVw9Cyq97AyN" }, "client_name": { "type": "string", "description": "Contact full name", "example": "Keva Ryan" }, "client_email": { "type": "string", "description": "Contact email address", "example": "keva.ryan@stark.ca" }, "system": { "type": "string", "example": "complycube", "enum": [ "complycube" ] }, "items": { "type": "array", "items": { "type": "string", "example": "extensive_screening_check" } }, "request_name": { "type": [ "string", "null" ], "example": "Onboarding documents" }, "request_id": { "type": [ "string", "null" ], "example": "req_1k7zv4aUlpN8PB" }, "tab_id": { "type": [ "string", "null" ], "example": "pag_jAxqEgBi4prM6g" }, "section_id": { "type": [ "string", "null" ], "example": "sec_YlVGMK1svdga0D" }, "field_id": { "type": [ "string", "null" ], "example": "fld_1lqbwY6TaMPmAo" }, "monitoring_enabled": { "type": "boolean", "example": true }, "checked_at": { "type": [ "string", "null" ], "example": "2026-04-23T09:38:00.000Z" }, "last_recheck_at": { "type": [ "string", "null" ], "example": "2026-04-23T09:38:00.000Z" }, "outcome": { "type": "string", "description": "The identity verification outcome. Possible values: `attention_required` (the provider flagged the client and it is awaiting human review), `manually_cleared` (a reviewer chose Proceed; previously sent as `reviewed`), `clear` (system auto-pass with no human review), and `manually_declined` (a reviewer chose Don't Proceed).", "example": "attention_required", "enum": [ "attention_required", "manually_cleared", "clear", "manually_declined" ] } } }, "id_verification_assets_redacted": { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "id_verification_assets_redacted", "default": "id_verification_assets_redacted" }, "id": { "type": "string", "description": "Client id", "example": "acc_MORVw9Cyq97AyN" }, "client_name": { "type": "string", "description": "Contact full name", "example": "Keva Ryan" }, "client_email": { "type": "string", "description": "Contact email address", "example": "keva.ryan@stark.ca" }, "system": { "type": "string", "example": "complycube", "enum": [ "complycube" ] }, "items": { "type": "array", "items": { "type": "string", "example": "identity_check" } }, "request_name": { "type": [ "string", "null" ], "example": "Onboarding documents" }, "request_id": { "type": [ "string", "null" ], "example": "req_1k7zv4aUlpN8PB" }, "tab_id": { "type": [ "string", "null" ], "example": "pag_jAxqEgBi4prM6g" }, "section_id": { "type": [ "string", "null" ], "example": "sec_YlVGMK1svdga0D" }, "field_id": { "type": [ "string", "null" ], "example": "fld_1lqbwY6TaMPmAo" }, "monitoring_enabled": { "type": "boolean", "example": true }, "checked_at": { "type": [ "string", "null" ], "example": "2026-04-23T09:38:00.000Z" }, "last_recheck_at": { "type": [ "string", "null" ], "example": "2026-04-23T09:38:00.000Z" }, "outcome": { "type": "string", "description": "The identity verification outcome of the client. Possible values: `attention_required`, `manually_cleared`, `clear`, `manually_declined` and `initial`. The value is `initial` when another check of the first verification is not finished yet.", "example": "attention_required", "enum": [ "initial", "attention_required", "manually_cleared", "clear", "manually_declined" ] } } }, "id_verification_client_marked_proceeding": { "$ref": "#/components/schemas/webhook_payloads/id_verification_decision" }, "id_verification_client_marked_not_proceeding": { "$ref": "#/components/schemas/webhook_payloads/id_verification_decision" }, "id_verification_client_mark_reset": { "$ref": "#/components/schemas/webhook_payloads/id_verification_decision" }, "id_verification_decision": { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "id_verification_client_marked_proceeding" }, "id": { "type": "string", "description": "Client id", "example": "acc_MORVw9Cyq97AyN" }, "client_name": { "type": "string", "description": "Contact full name", "example": "Keva Ryan" }, "client_email": { "type": "string", "description": "Contact email address", "example": "keva.ryan@stark.ca" }, "reviewer_id": { "type": "string", "description": "The prefixed id of the team member who made the decision", "example": "acc_e7EVAXvJfxZ9zb" }, "system": { "type": "string", "description": "The provider of the most recent check shown on the client card", "example": "complycube", "enum": [ "stripe", "complycube" ] }, "public_reference_id": { "type": "string", "description": "The most recent check shown on the client card: the ComplyCube client id, or the Stripe report id", "example": "6953932757101c00024185c2" }, "outcome": { "type": "string", "description": "The identity verification outcome. Possible values: `attention_required` (the provider flagged the client and it is awaiting human review), `manually_cleared` (a reviewer chose Proceed; previously sent as `reviewed`), `clear` (system auto-pass with no human review), and `manually_declined` (a reviewer chose Don't Proceed).", "example": "manually_cleared", "enum": [ "attention_required", "manually_cleared", "clear", "manually_declined" ] } } }, "integration_action_succeeded": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "integration_action_succeeded", "default": "integration_action_succeeded" } } }, { "$ref": "#/components/schemas/webhook_payloads/integration_action" } ] }, "integration_action_failed": { "allOf": [ { "type": "object", "properties": { "event_name": { "type": "string", "description": "A string that represents the name of the event", "example": "integration_action_failed", "default": "integration_action_failed" } } }, { "$ref": "#/components/schemas/webhook_payloads/integration_action" }, { "type": "object", "properties": { "errors": { "$ref": "#/components/schemas/webhook_payloads/error_messages" } } } ] } }, "client_company": { "type": "object", "properties": { "id": { "type": "string", "example": "cmp_z105QJxhy7YdlX" }, "name": { "type": "string", "example": "Trantow LLC" } } }, "client": { "type": "object", "properties": { "avatar": { "type": "string", "example": "https://example.com/user_avatar.jpeg" }, "client_companies": { "type": "array", "items": { "$ref": "#/components/schemas/client_company" } }, "company_name": { "type": "string", "example": "Trantow LLC" }, "email": { "type": "string", "example": "clayschaden@mail.org" }, "full_name": { "type": "string", "example": "Clay Schaden" }, "first_name": { "type": "string", "example": "Clay" }, "last_name": { "type": "string", "example": "Schaden" }, "id": { "type": "string", "example": "acc_MORVw9Cyq97AyN" }, "phone": { "type": "string", "example": "+1 (415) 555-1212" }, "salutation": { "type": [ "string", "null" ], "example": "Dr" }, "language_code": { "type": "string", "example": "en" } } }, "new_client": { "type": "object", "required": [ "email", "full_name" ], "properties": { "client_companies": { "type": "array", "items": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "Company name", "example": "Trantow LLC" } } } }, "email": { "type": "string", "description": "Contact email address", "example": "clayschaden@mail.org" }, "full_name": { "type": "string", "description": "Contact full name", "example": "Clay Schaden" }, "first_name": { "type": "string", "description": "Contact first name", "example": "Clay" }, "last_name": { "type": "string", "description": "Contact last name", "example": "Schaden" }, "phone": { "type": "string", "description": "Phone number", "example": "+1 (415) 555-1212" }, "salutation": { "type": [ "string", "null" ], "description": "Salutation (e.g. Mr, Mrs, Dr)", "example": "Dr" }, "language_code": { "type": "string", "description": "Language code", "example": "en", "enum": [ "en", "en-gb", "es", "fr", "de", "nl", "pt-br" ] } } }, "update_client": { "type": "object", "properties": { "client_companies": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Company name", "example": "Trantow LLC" } } } }, "email": { "type": "string", "description": "Contact email address", "example": "clayschaden@mail.org" }, "full_name": { "type": "string", "description": "Contact full name", "example": "Clay Schaden" }, "first_name": { "type": "string", "description": "Contact first name", "example": "Clay" }, "last_name": { "type": "string", "description": "Contact last name", "example": "Schaden" }, "phone": { "type": "string", "description": "Phone number", "example": "+1 (415) 555-1212" }, "salutation": { "type": [ "string", "null" ], "description": "Salutation (e.g. Mr, Mrs, Dr)", "example": "Dr" }, "language_code": { "type": "string", "description": "Language code", "example": "en", "enum": [ "en", "en-gb", "es", "fr", "de", "nl", "pt-br" ] } } }, "team_member": { "type": "object", "properties": { "active": { "type": "boolean", "example": false }, "avatar": { "type": "string", "example": "https://example.com/user_avatar.jpeg" }, "company_name": { "type": "string", "example": "Trantow LLC" }, "email": { "type": "string", "example": "clayschaden@mail.org" }, "first_name": { "type": "string", "example": "Clay" }, "full_name": { "type": "string", "example": "Clay Schaden" }, "id": { "type": "string", "example": "acc_e7EVAXvJfxZ9zb" }, "last_name": { "type": "string", "example": "Schaden" }, "phone": { "type": "string", "example": "+1 (415) 555-1212" }, "role": { "type": "string", "example": "viewer" }, "salutation": { "type": [ "string", "null" ], "example": "Dr" } } }, "new_team_member": { "type": "object", "required": [ "email", "full_name", "role" ], "properties": { "email": { "type": "string", "description": "Contact email address", "example": "clayschaden@mail.org" }, "full_name": { "type": "string", "description": "Contact full name", "example": "Clay Schaden" }, "personal_message": { "type": "string", "description": "The message is included in the invitation email", "example": "You have been invited ..." }, "phone": { "type": "string", "description": "Phone number", "example": "+1 (415) 555-1212" }, "role": { "type": "string", "description": "The user’s current role", "example": "editor", "enum": [ "admin", "editor", "reviewer", "viewer" ] } } }, "update_team_member": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Active (true) or inactive (false). It’s false if user is not allowed to use the system.", "example": false }, "role": { "type": "string", "description": "The user’s current role", "example": "editor", "enum": [ "admin", "editor", "reviewer", "viewer" ] } } }, "section_template": { "type": "object", "properties": { "description": { "type": "string", "example": "Template description" }, "id": { "type": "string", "example": "rtp_pdYGVjPxSJvA6y" }, "name": { "type": "string", "example": "Section Template 1" }, "source": { "$ref": "#/components/schemas/template_source" } } }, "tab_template": { "type": "object", "properties": { "description": { "type": "string", "example": "Template description" }, "id": { "type": "string", "example": "rtp_Nx5ELrl9S0glZ1" }, "name": { "type": "string", "example": "Page Template 1" }, "source": { "$ref": "#/components/schemas/template_source" } } }, "request_template": { "type": "object", "properties": { "description": { "type": "string", "example": "Template description" }, "id": { "type": "string", "example": "rtp_nRlwLZ1BiYvjWB" }, "name": { "type": "string", "example": "Request Template 1" }, "source": { "$ref": "#/components/schemas/template_source" } } }, "index_request": { "type": "object", "properties": { "due": { "type": "string", "example": "2024-08-15" }, "expires_after_due": { "type": "boolean", "example": false }, "folder_name": { "type": "string", "example": "Folder 1" }, "id": { "type": "string", "example": "req_1k7zv4aUlpN8PB" }, "name": { "type": "string", "example": "Request 1" }, "share_link": { "type": "string", "example": "https://webcorp.contentsnare.com/shared/6981788b-ce73-4bd6-985d-4eceec055ef9" }, "status": { "type": "string", "description": "Request status", "example": "published", "enum": [ "draft", "published", "completed", "archived", "scheduled", "waiting", "expired" ] }, "updated_at": { "type": "string", "example": "2025-01-15T12:00:00Z" } } }, "index_request_with_expand": { "allOf": [ { "$ref": "#/components/schemas/index_request" }, { "type": "object", "properties": { "request_template_name": { "type": [ "string", "null" ], "example": "Request Template 1" }, "owner_email": { "type": "string", "example": "keva.ryan@stark.ca" }, "owner_name": { "type": "string", "example": "Keva Ryan" }, "published_at": { "type": [ "string", "null" ], "format": "date-time", "example": "2026-07-01T10:00:00Z" }, "all_fields_completed_at": { "type": [ "string", "null" ], "format": "date-time", "example": "2026-07-02T11:00:00Z" }, "last_client_field_completed_at": { "type": [ "string", "null" ], "format": "date-time", "example": "2026-07-03T12:00:00Z" }, "last_team_field_reviewed_at": { "type": [ "string", "null" ], "format": "date-time", "example": "2026-07-04T13:00:00Z" }, "clients": { "type": "array", "items": { "$ref": "#/components/schemas/client_in_request" } } } } ] }, "show_request": { "type": "object", "required": [ "build_status" ], "properties": { "approved_fields_count": { "type": "integer", "example": 3 }, "author_name": { "type": [ "string", "null" ], "example": "Laurence Bosco" }, "board_column_id": { "type": [ "string", "null" ], "example": "bcl_b12Jl28mTJOea5" }, "board_column_sorting_position": { "type": [ "integer", "null" ], "example": 7 }, "build_status": { "type": "string", "enum": [ "building", "ready", "failed" ], "description": "Derived page-build state: failed if any page failed; building if no page failed and any page is not created; ready if all pages are created or none exist. Building is the only non-terminal value.", "example": "ready" }, "clients": { "type": "array", "items": { "$ref": "#/components/schemas/client_in_request" } }, "comments_enabled": { "type": "boolean", "example": true }, "communications_template_name": { "type": "string", "example": "Default" }, "completion_percentage": { "type": "integer", "example": 65 }, "country_code": { "type": [ "string", "null" ], "example": "us" }, "done_fields_count": { "type": "integer", "example": 1 }, "due": { "type": [ "string", "null" ], "example": "2024-08-15" }, "expires_after_due": { "type": "boolean", "example": false }, "fields_count": { "type": "integer", "example": 4 }, "folder_name": { "type": "string", "example": "Folder 1" }, "has_comments": { "type": "boolean", "example": true }, "id": { "type": "string", "example": "req_y8k0w9ASlnD4YX" }, "instruction_text": { "type": [ "string", "null" ], "example": "
Hi!
We’re happy to have you on board! We need some information from you. ...
" }, "language_code": { "type": "string", "example": "en" }, "name": { "type": "string", "example": "Request 1" }, "owner_id": { "type": [ "string", "null" ], "example": "acc_e7EVAXvJfxZ9zb" }, "owner_name": { "type": [ "string", "null" ], "example": "Julian Skiles" }, "pages": { "type": "array", "items": { "$ref": "#/components/schemas/tab_in_request" } }, "passcode_enabled": { "type": "boolean", "example": false }, "primary_client_id": { "type": [ "string", "null" ], "example": "acc_MORVw9Cyq97AyN" }, "redo_fields_count": { "type": "integer", "example": 0 }, "request_template_name": { "type": [ "string", "null" ], "example": "Request Template 1" }, "share_link": { "type": [ "string", "null" ], "example": "https://webcorp.contentsnare.com/shared/6981788b-ce73-4bd6-985d-4eceec055ef9" }, "share_via_link_enabled": { "type": "boolean", "example": true }, "show_instruction": { "type": "boolean", "example": true }, "status": { "type": "string", "description": "Request status", "example": "published", "enum": [ "draft", "published", "completed", "archived", "scheduled", "waiting", "expired" ] }, "wildcards": { "type": "object", "description": "Every supported instruction tag with its value for this request, keyed by the bare tag name. Values are raw text; sanitise them before you place them into HTML. A tag with nothing to resolve from has an empty value. The `clients.*` tags hold a list of strings, one per client, primary first. Join it in the viewer's language. The list is empty when nothing resolves it.\n", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "example": { "client.contact_first_name": "Fred", "client.company_name": "Smith & Sons", "clients.contact_first_name": [ "Fred", "Sam" ], "request.name": "Request 1" } }, "url": { "type": "string", "example": "https://webcorp.contentsnare.com/requests/143" }, "updated_at": { "type": "string", "example": "2025-01-15T12:00:00Z" } } }, "created_or_updated_request": { "type": "object", "required": [ "build_status" ], "properties": { "author_name": { "type": "string", "example": "Laurence Bosco" }, "build_status": { "type": "string", "enum": [ "building", "ready", "failed" ], "description": "Derived page-build state: failed if any page failed; building if no page failed and any page is not created; ready if all pages are created or none exist. Building is the only non-terminal value.", "example": "ready" }, "client_status": { "type": "string", "example": "existing" }, "client": { "$ref": "#/components/schemas/client_in_request" }, "clients": { "type": "array", "items": { "$ref": "#/components/schemas/client_in_request" } }, "comments_enabled": { "type": "boolean", "example": true }, "communications_template_name": { "type": "string", "example": "Default" }, "completion_percentage": { "type": "integer", "example": 65 }, "due": { "type": "string", "example": "2024-08-15" }, "expires_after_due": { "type": "boolean", "example": false }, "folder_name": { "type": "string", "example": "Folder 1" }, "id": { "type": "string", "example": "req_1k7zv4aUlpN8PB" }, "instruction_text": { "type": "string", "example": "
Hi!
We’re happy to have you on board! We need some information from you. ...
" }, "name": { "type": "string", "example": "Request 1" }, "owner_name": { "type": "string", "example": "Julian Skiles" }, "passcode_enabled": { "type": "boolean", "example": false }, "request_template_name": { "type": "string", "example": "Request Template 1" }, "share_link": { "type": "string", "example": "https://webcorp.contentsnare.com/shared/6981788b-ce73-4bd6-985d-4eceec055ef9" }, "share_via_link_enabled": { "type": "boolean", "example": true }, "show_instruction": { "type": "boolean", "example": false }, "status": { "type": "string", "description": "Request status", "example": "published", "enum": [ "draft", "published", "completed", "archived", "scheduled", "waiting", "expired" ] }, "wildcards": { "type": "object", "description": "Every supported instruction tag with its value for this request, keyed by the bare tag name. Values are raw text; sanitise them before you place them into HTML. A tag with nothing to resolve from has an empty value. The `clients.*` tags hold a list of strings, one per client, primary first. Join it in the viewer's language. The list is empty when nothing resolves it.\n", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "example": { "client.contact_first_name": "Fred", "client.company_name": "Smith & Sons", "clients.contact_first_name": [ "Fred", "Sam" ], "request.name": "Request 1" } }, "url": { "type": "string", "example": "https://webcorp.contentsnare.com/requests/143" }, "updated_at": { "type": "string", "example": "2025-01-15T12:00:00Z" } } }, "new_request": { "type": "object", "required": [ "name" ], "anyOf": [ { "required": [ "client_id" ] }, { "required": [ "client_email" ] }, { "required": [ "email" ] }, { "required": [ "client_assignments" ] }, { "required": [ "client_assignments_ids" ] } ], "not": { "anyOf": [ { "required": [ "client_assignments", "client_assignments_ids" ] }, { "required": [ "client_id", "client_assignments" ] }, { "required": [ "client_id", "client_assignments_ids" ] } ] }, "properties": { "client_id": { "type": "string", "description": "Preferred client id for creating a request with one existing client. Use an internal client id (`acc_...`) or an external client id (`exc_...`). This parameter cannot be used together with `client_assignments` or `client_assignments_ids`.\n", "example": "acc_MORVw9Cyq97AyN" }, "client_assignments": { "type": "array", "minItems": 1, "description": "Preferred assignment array for creating or updating a request with one or more existing clients. Use `account_id` for each client. This parameter is mutually exclusive with `client_id` and `client_assignments_ids`.\n", "items": { "$ref": "#/components/schemas/client_assignment_id" } }, "client_assignments_ids": { "type": "array", "minItems": 1, "deprecated": true, "description": "Deprecated. Use `client_assignments` instead. Responses include `Deprecation`, `Sunset`, and `Link` headers with deprecation metadata and migration documentation when this parameter is used.\n", "items": { "$ref": "#/components/schemas/client_assignment_id_deprecated" } }, "client_email": { "type": "string", "deprecated": true, "description": "Deprecated. Use `client_id` instead for existing clients. The value is trimmed and matched case-insensitively. Existing internal clients are reused first. If no internal client exists, a matching external client from an active client integration is used. Archived internal clients are not duplicated; request creation is rejected. If no client matches, a new client is created, and client_full_name is required.\n", "example": "keva.ryan@stark.ca" }, "email": { "type": "string", "deprecated": true, "description": "Deprecated. Use `client_id` instead for existing clients.\n", "example": "keva.ryan@stark.ca" }, "client_full_name": { "type": "string", "description": "Required for new clients. You may leave blank for existing clients. Providing a value will overwrite the existing name.", "example": "Keva Ryan" }, "client_phone": { "type": "string", "description": "For existing clients, providing a value will overwrite the existing phone.", "example": "+1 (415) 555-1212" }, "comments_enabled": { "type": "boolean", "description": "Enable client comments. This allows your client to ask questions about each field.", "example": true }, "communication_template_id": { "type": "string", "description": "Id of communications schedule", "example": "ctp_R0yJ9VqTGD8j5n" }, "communication_template_name": { "type": "string", "deprecated": true, "description": "Deprecated. Use `communication_template_id` instead. Name of communications schedule.", "example": "Schedule name" }, "company_name": { "type": "string", "description": "If this company name is not already associated with this client, it will be created.", "example": "Torphy Group" }, "due": { "type": "string", "description": "Due date for the request.
Format: yyyy-mm-dd", "default": "14 days from creation", "example": "2024-08-15" }, "expires_after_due": { "type": "boolean", "description": "When true, the request is closed once the due date passes — it moves to the completed status with an expiry timestamp, and the client loses access. The request itself stays available to your team, and publishing it again with a later due date reopens it.", "default": false, "example": true }, "folder_id": { "type": "string", "description": "Folder id. Requests may be grouped in to folders on the requests page. Don't send it if you do not wish to group your Requests.", "example": "fol_9eav8o0bH2P71Q" }, "folder_name": { "type": "string", "deprecated": true, "description": "Deprecated. Use `folder_id` instead. Requests may be grouped into folders on the requests page. Don't send it if you do not wish to group your requests.", "default": "Default Folder", "example": "Folder 1" }, "name": { "type": "string", "description": "Request name", "example": "Request 1" }, "owner_id": { "type": "string", "description": "Request owner (team member) id", "default": "current user id", "example": "acc_e7EVAXvJfxZ9zb" }, "owner_email": { "type": "string", "deprecated": true, "description": "Deprecated. Use `owner_id` instead. Request owner (team member) email.", "default": "current user email", "example": "theolacorwin@mail.org" }, "passcode_enabled": { "type": "boolean", "description": "Protect share with a pin code. Your client will be asked to set their own pincode when they first access the request.", "default": false, "example": false }, "request_template_id": { "type": "string", "description": "Preferred request template id.", "example": "rtp_nRlwLZ1BiYvjWB" }, "request_template_name": { "type": "string", "deprecated": true, "description": "Deprecated. Use `request_template_id` instead. Request template name.", "example": "Request Template 1" }, "share_via_link_enabled": { "type": "boolean", "description": "Allow share via link without requiring login", "default": false, "example": true }, "status": { "type": "string", "description": "Request status", "default": "draft", "example": "published", "enum": [ "published", "draft" ] }, "updated_at": { "type": "string", "example": "2025-01-15T12:00:00Z" } } }, "update_request": { "type": "object", "not": { "required": [ "client_assignments", "client_assignments_ids" ] }, "properties": { "client_assignments": { "type": "array", "minItems": 1, "description": "Preferred assignment array for creating or updating a request with one or more existing clients. Use `account_id` for each client. This parameter is mutually exclusive with `client_id` and `client_assignments_ids`.\n", "items": { "$ref": "#/components/schemas/client_assignment_id" } }, "client_assignments_ids": { "type": "array", "minItems": 1, "deprecated": true, "description": "Deprecated. Use `client_assignments` instead. Responses include `Deprecation`, `Sunset`, and `Link` headers with deprecation metadata and migration documentation when this parameter is used.\n", "items": { "$ref": "#/components/schemas/client_assignment_id_deprecated" } }, "comments_enabled": { "type": "boolean", "description": "Enable client comments. This allows your client to ask questions about each field.", "example": true }, "communication_template_id": { "type": "string", "description": "Id of communications schedule. Set this parameter as null to remove existing communications schedule from request.", "example": "ctp_R0yJ9VqTGD8j5n" }, "communication_template_name": { "type": "string", "deprecated": true, "description": "Deprecated. Use `communication_template_id` instead. Set `communication_template_id` as null to remove existing communications schedule from request.", "example": "Schedule name" }, "due": { "type": "string", "description": "Due date for the request.
Format: yyyy-mm-dd", "example": "2024-08-15" }, "expires_after_due": { "type": "boolean", "description": "When true, the request is closed once the due date passes — it moves to the completed status with an expiry timestamp, and the client loses access. The request itself stays available to your team, and publishing it again with a later due date reopens it.", "example": true }, "folder_id": { "type": "string", "description": "Folder id. Requests may be grouped in to folders on the requests page. Don't send it if you do not wish to group your Requests.", "example": "fol_9eav8o0bH2P71Q" }, "folder_name": { "type": "string", "deprecated": true, "description": "Deprecated. Use `folder_id` instead. Requests may be grouped into folders on the requests page. Don't send it if you do not wish to group your requests.", "example": "Folder 1" }, "instruction_text": { "type": "string", "description": "Request instructions are the first thing your client will see when they open the request. Use this area to let them know who you are, what the request is for, and provide some simple instructions on how to use Content Snare.", "example": "
Hi!
We’re happy to have you on board! We need some information from you. ...
" }, "name": { "type": "string", "description": "Request name", "example": "Request 1" }, "owner_id": { "type": "string", "description": "Request owner (team member) id", "example": "acc_e7EVAXvJfxZ9zb" }, "owner_email": { "type": "string", "deprecated": true, "description": "Deprecated. Use `owner_id` instead. Request owner (team member) email.", "example": "theolacorwin@mail.org" }, "passcode_enabled": { "type": "boolean", "description": "Protect share with a pin code. Your client will be asked to set their own pincode when they first access the request.", "example": false }, "share_via_link_enabled": { "type": "boolean", "description": "Allow share via link without requiring login", "example": true }, "show_instruction": { "type": "boolean", "description": "Enable request instructions", "example": true }, "status": { "type": "string", "description": "Request status", "example": "published", "enum": [ "draft", "published", "completed", "archived" ] }, "updated_at": { "type": "string", "example": "2025-01-15T12:00:00Z" } } }, "client_in_request": { "type": "object", "properties": { "avatar": { "type": "string", "example": "https://example.com/user_avatar.jpeg" }, "company_name": { "type": "string", "example": "Stark Enterprises" }, "email": { "type": "string", "example": "keva.ryan@stark.ca" }, "first_name": { "type": "string", "example": "Keva" }, "full_name": { "type": "string", "example": "Keva Ryan" }, "id": { "type": "string", "example": "acc_MORVw9Cyq97AyN" }, "last_name": { "type": "string", "example": "Ryan" }, "phone": { "type": "string", "example": "+1 (415) 555-1212" }, "salutation": { "type": [ "string", "null" ], "example": "Dr" }, "url": { "type": "string", "example": "https://webcorp.contentsnare.com/shared/b5cd2ffc-b290-40ff-bea9-adea3dc1994b" } } }, "tab_in_request": { "type": "object", "properties": { "approved_fields_count": { "type": "integer", "example": 1 }, "done_fields_count": { "type": "integer", "example": 1 }, "fields_count": { "type": "integer", "example": 2 }, "id": { "type": "string", "example": "pag_jAxqEgBi4prM6g" }, "instruction_text": { "type": [ "string", "null" ], "example": "
Page instruction
" }, "is_approved": { "type": "boolean", "example": true }, "is_done": { "type": "boolean", "example": false }, "name": { "type": "string", "example": "Page 1" }, "redo_fields_count": { "type": "integer", "example": 0 }, "reference_id": { "type": "string", "example": "rpag_jAxqEgBi4prM6g", "description": "A reference ID is an identifier, unique within a request, that remains consistent across all instances of a page in multiple requests and request templates" }, "show_instruction": { "type": "boolean", "example": false }, "sorting_position": { "type": "integer", "example": 0 } } }, "tab": { "type": "object", "properties": { "approved_fields_count": { "type": "integer", "example": 1 }, "done_fields_count": { "type": "integer", "example": 1 }, "fields_count": { "type": "integer", "example": 2 }, "id": { "type": "string", "example": "pag_jAxqEgBi4prM6g" }, "instruction_text": { "type": "string", "example": "
Page instruction
" }, "is_approved": { "type": "boolean", "example": true }, "is_done": { "type": "boolean", "example": false }, "name": { "type": "string", "example": "Page 1" }, "redo_fields_count": { "type": "integer", "example": 0 }, "reference_id": { "type": "string", "example": "rpag_jAxqEgBi4prM6g", "description": "A reference ID is an identifier, unique within a request, that remains consistent across all instances of a page in multiple requests and request templates" }, "sections": { "type": "array", "items": { "$ref": "#/components/schemas/section" } }, "show_instruction": { "type": "boolean", "example": false }, "sorting_position": { "type": "integer", "example": 0 } } }, "new_tab": { "type": "object", "required": [ "request_id" ], "properties": { "name": { "type": "string", "description": "Page name. If it isn't set then the source template name is used.", "example": "Page 1" }, "request_id": { "type": "string", "description": "Id of a request where a new page should be added", "example": "req_1k7zv4aUlpN8PB" }, "source_template_id": { "type": "string", "description": "Source page template id (`source_template_id` or `source_template_name` should be set)", "example": "rtp_Nx5ELrl9S0glZ1" }, "source_template_name": { "type": "string", "description": "Source page template name (`source_template_id` or `source_template_name` should be set)", "example": "Page Template 1" } } }, "section": { "type": "object", "properties": { "compressed": { "type": "boolean", "description": "A boolean value indicating whether the section is displayed as a single compressed block with one submit button", "example": false }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/field" } }, "id": { "type": "string", "example": "sec_YlVGMK1svdga0D" }, "instruction_text": { "type": "string", "example": "
Section instruction
" }, "name": { "type": "string", "example": "Section 1" }, "show_instruction": { "type": "boolean", "example": true }, "sorting_position": { "type": "integer", "example": 1 }, "reference_id": { "type": "string", "example": "rsec_YlVGMK1svdga0D", "description": "A reference ID is an identifier, unique within a page, that remains consistent across all instances of a section, whether in multiple requests or within duplicated pages of the same request" } } }, "new_section": { "type": "object", "required": [ "page_id" ], "properties": { "compressed": { "type": "boolean", "description": "A boolean value indicating whether the section is displayed as a single compressed block with one submit button", "example": false }, "name": { "type": "string", "description": "Section name. If it isn't set then the source template name is used.", "example": "Section 1" }, "page_id": { "type": "string", "description": "Id of a page where a new section should be added", "example": "pag_jAxqEgBi4prM6g" }, "source_template_id": { "type": "string", "description": "Source section template id (`source_template_id` or `source_template_name` should be set)", "example": "rtp_pdYGVjPxSJvA6y" }, "source_template_name": { "type": "string", "description": "Source section template name (`source_template_id` or `source_template_name` should be set)", "example": "Section Template 1" } } }, "field": { "type": "object", "properties": { "additional_fields": { "type": "array", "items": { "$ref": "#/components/schemas/additional_field" } }, "answers": { "type": "array", "deprecated": true, "description": "DEPRECATED", "items": { "$ref": "#/components/schemas/answer" } }, "field_columns": { "type": "array", "items": { "$ref": "#/components/schemas/field_column" } }, "field_configuration": { "$ref": "#/components/schemas/field_configuration" }, "id": { "type": "string", "example": "fld_1lqbwY6TaMPmAo" }, "images": { "type": "array", "items": { "$ref": "#/components/schemas/image" } }, "instruction_text": { "type": "string", "example": "
Field instruction
" }, "internal": { "type": "boolean", "example": false, "description": "A boolean value indicating whether the field is visible only to team members and hidden from clients" }, "min_answer_count": { "type": "integer", "example": 1 }, "max_answer_count": { "type": "integer", "example": 5 }, "name": { "type": "string", "example": "Text Field 1" }, "placeholder": { "type": "string", "example": "Placeholder text" }, "rejection_message": { "$ref": "#/components/schemas/rejection_message" }, "repeater_enabled": { "type": "boolean", "example": true }, "required": { "type": "boolean", "example": false }, "show_instruction": { "type": "boolean", "example": false }, "sorting_position": { "type": "integer", "example": 5 }, "status": { "type": "string", "example": "redo" }, "reference_id": { "type": "string", "example": "rfld_1lqbwY6TaMPmAo", "description": "A reference ID is a unique identifier that remains consistent across all instances of a field, whether in multiple requests or within repeated sections of the same request" }, "sub_type": { "type": "string", "example": "text" }, "type": { "type": "string", "example": "Fields::Text" }, "values": { "type": "array", "items": { "type": "string", "example": "Example completed field answer" } }, "values_flat": { "type": "string", "example": "Example completed field answer" }, "values_structured": { "$ref": "#/components/schemas/field_values_structured" } } }, "answer": { "type": "object", "properties": { "attachment": { "$ref": "#/components/schemas/attachment" }, "id": { "type": "string", "example": "ans_RQ1zp49c7Xz4km" }, "field_id": { "type": "string", "example": "fld_1lqbwY6TaMPmAo" }, "link": { "type": "string", "example": "https://..." }, "rejection_comment": { "type": "string", "example": "rejection reason" }, "row": { "type": "array", "items": { "$ref": "#/components/schemas/answer_segment" } }, "sorting_position": { "type": "integer", "example": 3 }, "status": { "type": "string", "example": "todo" }, "text": { "type": "array", "items": { "type": "string" }, "example": [ "answer text" ] } } }, "answer_segment": { "type": "object", "properties": { "field_column_id": { "type": "string", "example": "fcl_G60KqQ61ubvAnP" }, "text": { "type": "string", "example": "table cell text" } } }, "additional_field": { "type": "object", "properties": { "id": { "type": "string", "example": "afd_LWdqOpnaT56vo0" }, "sorting_position": { "type": "integer", "example": 0 }, "text": { "type": "string", "example": "Option1" } } }, "field_configuration": { "type": "object", "properties": { "id": { "type": "string", "example": "afd_LWdqOpnaT56vo0" }, "settings": { "type": "object", "additionalProperties": true, "example": { "some_setting1": "val1", "some_setting2": { "nested_setting1": "val2" } } } } }, "field_column": { "type": "object", "properties": { "id": { "type": "string", "example": "fcl_G60KqQ61ubvAnP" }, "name": { "type": "string", "example": "Column 1" }, "read_only": { "type": "boolean", "example": false }, "required": { "type": "boolean", "example": true }, "sorting_position": { "type": "integer", "example": 0 } } }, "client_assignment_id": { "type": "object", "required": [ "account_id" ], "properties": { "account_id": { "type": "string", "description": "Client id. Use an internal client id (`acc_...`) or an external client id (`exc_...`).", "example": "acc_MORVw9Cyq97AyN" }, "client_company_id": { "type": "string", "description": "Client company id for the assignment. Use a `cmp_...` id returned by the API. For external-client assignments, this value is optional; the company from the resolved external client is used.\n", "example": "cmp_z105QJxhy7YdlX" }, "primary": { "type": "boolean", "description": "Set true to mark client as primary. Only one client in request can be primary.", "example": true } } }, "client_assignment_id_deprecated": { "type": "object", "deprecated": true, "required": [ "account_id" ], "properties": { "account_id": { "oneOf": [ { "type": "string", "description": "Client id. Use an internal client id (`acc_...`) or an external client id (`exc_...`).", "example": "acc_MORVw9Cyq97AyN" }, { "type": "integer", "description": "Deprecated integer client id. Use prefixed client ids instead.", "example": 123 } ] }, "client_company_id": { "oneOf": [ { "type": "string", "description": "Client company id for the assignment. Use a `cmp_...` id returned by the API. For external-client assignments, this value is optional; the company from the resolved external client is used.\n", "example": "cmp_z105QJxhy7YdlX" }, { "type": "integer", "description": "Deprecated integer client company id. Use prefixed client company ids instead.", "example": 123 } ] }, "primary": { "type": "boolean", "description": "Set true to mark client as primary. Only one client in request can be primary.", "example": true } } }, "assignment_validation_errors_object": { "type": "object", "properties": { "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "example": { "client_assignments[0].account_id": [ "is invalid" ] } } } }, "review_field": { "type": "object", "properties": { "answers_attributes": { "type": "array", "deprecated": true, "description": "DEPRECATED", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Answer id", "example": "ans_RQ1zp49c7Xz4km" }, "rejection_comment": { "type": "string", "description": "A message for your client letting them know why you rejected the answer and what they need to do to fix it", "example": "Rejection reason" }, "status": { "type": "string", "description": "Answer status.
Set status 'approved' for the following actions: approve.
status 'todo' for the following actions: remove reject, remove approval.
Set status 'redo' for the following actions: reject.", "example": "redo", "enum": [ "approved", "redo", "todo" ] } } } }, "rejection_comment": { "type": "string", "description": "A message for your client letting them know why you rejected the field and what they need to do to fix it", "example": "Rejection reason" }, "status": { "type": "string", "description": "Field status.
Set status 'approved' for the following actions: approve.
Set status 'done' for the following actions: submit for review, remove reject, remove approval.
Set status 'todo' for the following actions: revise.
Set status 'redo' for the following actions: reject.", "example": "redo", "enum": [ "approved", "done", "redo", "todo" ] } } }, "reviewed_field": { "type": "object", "properties": { "answers": { "type": "array", "deprecated": true, "description": "DEPRECATED", "items": { "type": "object", "properties": { "id": { "type": "string", "example": "ans_RQ1zp49c7Xz4km" }, "rejection_comment": { "type": "string", "example": "Rejection reason" }, "status": { "type": "string", "example": "redo" } } } }, "id": { "type": "string", "example": "fld_1lqbwY6TaMPmAo" }, "rejection_comment": { "type": "string", "example": "Rejection reason" }, "status": { "type": "string", "example": "redo" } } }, "rejection_message": { "type": "object", "properties": { "text": { "type": "string", "example": "rejection reason" } } }, "attachment": { "type": "object", "properties": { "byte_size": { "type": "integer", "example": 74226 }, "filename": { "type": "string", "example": "doc1.jpeg" }, "signed_id": { "type": "string", "example": "eyJfcmFpbHMiOnsibWVzc2FnZSI6..." }, "url": { "type": "string", "example": "https://example.com/documents/doc1.jpeg" } } }, "image": { "type": "object", "properties": { "byte_size": { "type": "integer", "example": 74226 }, "filename": { "type": "string", "example": "doc1.jpeg" }, "image": { "type": "object", "properties": { "height": { "type": "integer", "example": 183 }, "url": { "type": "string", "example": "https://example.com/documents/doc1.jpeg" }, "width": { "type": "integer", "example": 275 } } }, "signed_id": { "type": "string", "example": "eyJfcmFpbHMiOnsibWVzc2FnZSI6..." }, "thumbnail": { "type": "object", "properties": { "height": { "type": "integer", "example": 64 }, "url": { "type": "string", "example": "https://example.com/documents/thumbnails/doc1.jpeg" }, "width": { "type": "integer", "example": 92 } } }, "url": { "type": "string", "example": "https://example.com/documents/doc1.jpeg" } } }, "field_values_structured": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "value": { "type": "string", "example": "Example completed field answer" } } }, { "type": "object", "description": "For fields with sub_type 'checkbox', 'radio', 'task list', 'select', 'image select'", "properties": { "values": { "type": "array", "items": { "type": "string" }, "example": [ "Option1", "Option2" ] } } }, { "type": "object", "description": "For fields with sub_type 'abr verification'", "properties": { "identifier": { "type": "string", "example": "14668995138" }, "type": { "type": "string", "example": "ABN/ACN" }, "confirmed": { "type": "string", "example": "Yes/No" }, "entity_name": { "type": "string", "example": "Company Name" }, "location": { "type": "string", "example": "QLD 1234" }, "active": { "type": "string", "example": "Yes/No" } } }, { "type": "object", "description": "For fields with sub_type 'address'", "properties": { "formatted_address": { "type": "string", "example": "23 Streatham Hill, London SW1 2TS, UK" }, "street_number": { "type": "string", "example": "23" }, "street_address": { "type": "string", "example": "Streatham Hill" }, "locality": { "type": "string", "example": "London" }, "administrative_area": { "type": "string", "example": "Greater London" }, "country": { "type": "string", "example": "United Kingdom" }, "post_code": { "type": "string", "example": "SW1 2TS" } } }, { "type": "object", "description": "For fields with sub_type 'button'", "properties": { "button_text": { "type": "string", "example": "Button Name" }, "link_to_url": { "type": "string", "example": "https://..." } } }, { "type": "object", "description": "For fields with sub_type 'currency'", "properties": { "formatted_value": { "type": "string", "example": "US$23.75" }, "currency_code": { "type": "string", "example": "USD" }, "amount": { "type": "string", "example": "23.75" } } }, { "type": "object", "description": "For fields with sub_type 'date_range'", "properties": { "start_date": { "type": "string", "example": "2024-11-28" }, "end_date": { "type": "string", "example": "2024-12-02" }, "number_of_days": { "type": "integer", "example": 5 } } }, { "type": "object", "description": "For fields with sub_type 'signature'", "properties": { "signed": { "type": "boolean", "example": true }, "user_name": { "type": "string", "example": "Clay Schaden" }, "ip_address": { "type": "string", "example": "44.132.129.48" }, "signed_at": { "type": "string", "example": "2024-11-18T15:50:50.161Z" } } }, { "type": "object", "description": "For fields with sub_type 'country select'", "properties": { "country_code": { "type": "string", "example": "au" }, "name": { "type": "string", "example": "Australia" } } } ] } }, "webhook": { "type": "object", "properties": { "enabled": { "type": "boolean", "example": true }, "id": { "type": "string", "example": "whk_ObYa4GYbUdoN9X" }, "subscriptions": { "type": "array", "items": { "type": "string" }, "example": [ "client_created", "client_updated", "client_destroyed" ] }, "type": { "type": "string", "example": "api (or ui)" }, "url": { "type": "string", "example": "https://example.com/handle_webhook" } } }, "new_or_update_webhook": { "type": "object", "required": [ "url" ], "properties": { "enabled": { "type": "boolean", "description": "Specifies if webhook is enabled", "default": true, "example": true }, "subscriptions": { "type": "array", "description": "List of events associated with webhook", "items": { "type": "string", "enum": [ "all_fields_completed", "client_create_failed", "client_created", "client_destroy_failed", "client_destroyed", "client_portal_group_created", "client_portal_group_destroyed", "client_portal_group_updated", "client_portal_viewed", "client_update_failed", "client_updated", "comment_create_failed", "comment_created", "email_bounced", "email_delivered", "email_spam_complained", "field_approved", "field_completed", "field_rejected", "id_verification_assets_redacted", "id_verification_client_mark_reset", "id_verification_client_marked_not_proceeding", "id_verification_client_marked_proceeding", "id_verification_completed", "id_verification_monitoring_updated", "integration_action_failed", "integration_action_succeeded", "internal_comment_created", "page_completed", "product_item_auto_purchase", "product_item_exhausted", "product_item_manual_purchase", "product_item_purchase_failed", "product_item_returned", "product_item_used", "recurring_request_completed", "recurring_request_created", "recurring_request_destroyed", "recurring_request_executed", "recurring_request_failed", "request_archived", "request_archived_failed", "request_board_column_change_failed", "request_board_column_changed", "request_completed", "request_completed_failed", "request_create_failed", "request_created", "request_destroy_failed", "request_destroyed", "request_draft", "request_expired", "request_exported", "request_owner_reassigned", "request_published", "request_published_failed", "request_scheduled", "request_update_failed", "request_updated", "request_viewed", "request_waiting_for_approval", "scheduled_request_failed_to_publish", "scheduled_request_published_but_limits_exceeded", "section_completed", "signature_completed", "sms_delivered", "sms_failed", "team_member_create_failed", "team_member_created", "team_member_destroy_failed", "team_member_destroyed", "team_member_update_failed", "team_member_updated", "webhook_delivery_failed" ] }, "example": [ "client_created", "client_updated", "client_destroyed" ] }, "url": { "type": "string", "description": "Your webhook URL", "example": "https://example.com/handle_webhook" } } }, "folder": { "type": "object", "properties": { "id": { "type": "string", "example": "fol_9eav8o0bH2P71Q" }, "name": { "type": "string", "example": "Folder1" } } }, "communication_template": { "type": "object", "properties": { "id": { "type": "string", "example": "ctp_R0yJ9VqTGD8j5n" }, "name": { "type": "string", "example": "Schedule1" }, "description": { "type": "string", "example": "schedule description" }, "source": { "$ref": "#/components/schemas/communication_template_source" } } }, "errors_object": { "type": "object", "properties": { "errors": { "items": { "type": "string" }, "type": "array" } } }, "errors_object_with_extra_integration_action_data": { "type": "object", "properties": { "errors": { "items": { "type": "string" }, "type": "array" }, "error_data": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "create_client" ] }, "page_id": { "type": "string", "example": null, "description": "Id of the page to which the integration action is assigned. It's null if `section_id` is filled." }, "reason": { "type": "string", "example": "Email must be in a valid format." }, "request_id": { "type": "string", "example": "req_7v80jRXCo90mAo" }, "section_id": { "type": "string", "example": "sec_WBkg4PxC7agM0P", "description": "Id of the section to which the integration action is assigned. It's null if `page_id` is filled." } } } } } }, "limit": { "type": "integer", "default": 200, "example": 20 }, "offset": { "type": "integer", "default": 0, "example": 0 }, "sort_direction": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" }, "sort_by_client_companies": { "type": "string", "enum": [ "name" ], "default": "name" }, "sort_by_clients": { "type": "string", "enum": [ "client_companies.name", "email", "full_name", "phone" ], "default": "full_name" }, "sort_by_requests": { "type": "string", "enum": [ "name", "due", "status", "updated_at" ], "default": "name" }, "sort_by_team_members": { "type": "string", "enum": [ "email", "full_name", "phone", "role" ], "default": "full_name" }, "filter_by_request_statuses": { "type": "array", "items": { "type": "string", "enum": [ "published", "scheduled", "draft", "completed", "archived", "waiting", "expired" ] }, "collectionFormat": "multi" }, "filter_by_template_source": { "type": "string", "enum": [ "company", "built_in", "shared" ], "example": "company" }, "template_source": { "type": "string", "enum": [ "company", "built_in", "shared" ], "example": "company" }, "communication_template_source": { "type": "string", "enum": [ "company", "built_in" ], "example": "company" }, "filter_by_client_email": { "type": "string", "example": "james@example.com" }, "filter_by_client_full_name": { "type": "string", "example": "James Smith" }, "filter_by_client_phone": { "type": "string", "example": "+15551010001" }, "q_by_client_companies": { "type": "array", "items": { "type": "string", "enum": [ "name" ], "default": "name" }, "collectionFormat": "multi" }, "q_by_clients": { "type": "array", "items": { "type": "string", "enum": [ "client_companies.name", "email", "full_name", "phone" ], "default": "client_companies.name, email, full_name, phone" }, "collectionFormat": "multi" }, "q_by_team_members": { "type": "array", "items": { "type": "string", "enum": [ "email", "full_name", "phone", "role" ], "default": "email, full_name, phone, role" }, "collectionFormat": "multi" }, "q_by_requests": { "type": "array", "items": { "type": "string", "enum": [ "name", "clients.email", "clients.full_name", "owner.email", "owner.full_name", "client_companies.name", "folder.name", "request_template.name" ], "default": "name, clients.email, clients.full_name, owner.email, owner.full_name, client_companies.name, folder.name, request_template.name" }, "collectionFormat": "multi" }, "pagination": { "type": "object", "properties": { "limit": { "type": "integer", "example": 200 }, "offset": { "type": "integer", "example": 0 }, "total_count": { "type": "integer", "example": 425 } } }, "pagination_templates": { "type": "object", "properties": { "limit": { "type": "integer", "example": 200 }, "offset": { "type": "integer", "example": 0 }, "total_count": { "type": "integer", "example": 425 }, "filter_by": { "type": "object", "properties": { "source": { "$ref": "#/components/schemas/filter_by_template_source" } } } } }, "pagination_client_companies": { "type": "object", "properties": { "limit": { "type": "integer", "example": 200 }, "offset": { "type": "integer", "example": 0 }, "q": { "type": "string", "example": "str" }, "q_by": { "type": "array", "items": { "type": "string" }, "example": [ "name" ] }, "sort_by": { "type": "string", "example": "name" }, "sort_direction": { "type": "string", "example": "asc" }, "total_count": { "type": "integer", "example": 425 } } }, "pagination_clients": { "type": "object", "properties": { "limit": { "type": "integer", "example": 200 }, "offset": { "type": "integer", "example": 0 }, "q": { "type": "string", "example": "str" }, "q_by": { "type": "array", "items": { "type": "string" }, "example": [ "email", "full_name" ] }, "sort_by": { "type": "string", "example": "email" }, "sort_direction": { "type": "string", "example": "asc" }, "filter_by": { "type": "object", "example": { "email": "james@example.com" } }, "total_count": { "type": "integer", "example": 425 } } }, "pagination_team_members": { "type": "object", "properties": { "limit": { "type": "integer", "example": 200 }, "offset": { "type": "integer", "example": 0 }, "q": { "type": "string", "example": "str" }, "q_by": { "type": "array", "items": { "type": "string" }, "example": [ "full_name", "phone" ] }, "sort_by": { "type": "string", "example": "phone" }, "sort_direction": { "type": "string", "example": "asc" }, "total_count": { "type": "integer", "example": 425 } } }, "pagination_requests": { "type": "object", "properties": { "limit": { "type": "integer", "example": 200 }, "offset": { "type": "integer", "example": 0 }, "q": { "type": "string", "example": "str" }, "q_by": { "type": "array", "items": { "type": "string" }, "example": [ "name", "clients.full_name", "client_companies.name" ] }, "sort_by": { "type": "string", "example": "name" }, "sort_direction": { "type": "string", "example": "asc" }, "total_count": { "type": "integer", "example": 425 }, "filter_by": { "type": "object", "properties": { "statuses": { "type": "array", "items": { "type": "string" }, "example": [ "published", "completed" ] } } } } } } } }