Skip to main content

API Quick Reference

This documentation provides details about CRUD for campaign pages.

Updated over 2 months ago

Required Headers

  • Accept: Must always be set to application/json.

  • Authorization: Set as Bearer {access_token} for authenticated access.

{
"Accept": "application/json",
"Authorization": "Bearer {access_token}"
}

HTTP Status Codes

Status Code

Description

200 OK

The request was successful.

201 Created

The resource was created successfully (applies to adding pages).

400 Bad Request

Input data is invalid. Example: Attempt to modify a default template or missing required fields. Always you will have message field with detailed description

401 Unauthorized

Authorization {access_token} is invalid or expired.

403 Forbidden

User does not have the necessary permissions to access this resource.

404 Not Found

Resource not found. Example: Template or page does not exist.

422 Unprocessable Entity

Validation failed for the request payload. Check errors field in the response for details.

500 Internal Server Error

Server encountered an error when handling the request.

502 Bad Gateway

The server is temporarily unavailable. This might be due to ongoing deployment or issues with the backend server.

URL Parameters

Name

Type

Required

Description

Example

workspace_id

integer

Yes

The ID of the campaign’s workspace.

1

campaign_id

integer

Yes

The ID of the template (campaign).

10

Did this answer your question?