Create screen – ConversionLab Docs

POST /screens

Create screen. Requires the REST write token ability. The bearer token selects the Team; a supplied team_id cannot switch tenants. Additional role, entity-policy and plan requirements vary by operation. A Team in blocked billing mode cannot write and receives 402.

Authentication

Use a team API key as Authorization: Bearer YOUR_API_KEY. The token ability and the user’s role must both allow this operation. See authentication.

{
  "ability": "write",
  "team": "Token-bound Team",
  "authorization": "Additional role, entity-policy and plan requirements vary by operation.",
  "billing": "Blocked billing mode rejects writes with 402."
}

Request body

A request body is required.

multipart/form-data

{
  "type": "object",
  "properties": {
    "project_id": {
      "type": "integer"
    },
    "research_collection_id": {
      "type": [
        "integer",
        "null"
      ]
    },
    "audience_id": {
      "type": [
        "integer",
        "null"
      ]
    },
    "page_id": {
      "type": [
        "integer",
        "null"
      ]
    },
    "name": {
      "type": "string",
      "maxLength": 255
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 65535
    },
    "image": {
      "type": "string",
      "format": "binary",
      "contentMediaType": "application/octet-stream",
      "description": "Maximum file size: 25600 kilobytes."
    }
  },
  "required": [
    "project_id",
    "name",
    "image"
  ],
  "title": "StoreScreenRequest"
}

{
  "project_id": 101,
  "name": "Checkout delivery estimate",
  "description": null,
  "image": "screenshot.png"
}

Example request

For file fields, replace the synthetic local filename with an existing file of the documented type and size. Let curl set the multipart boundary.

curl --request POST 'https://api.example.test/api/screens' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json' \
  --form-string 'project_id=101' \
  --form-string 'name=Checkout delivery estimate' \
  --form 'image=@./screenshot.png'

Examples use fictional data. Replace resource IDs and the API host with your environment’s values.

Responses

200

ScreenResource

Content type: application/json.

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer"
        },
        "project_id": {
          "type": "integer"
        },
        "research_collection_id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "audience_id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "page_id": {
          "type": [
            "integer",
            "null"
          ]
        },
        "name": {
          "type": [
            "string",
            "null"
          ]
        },
        "description": {
          "type": [
            "string",
            "null"
          ]
        },
        "image": {
          "type": [
            "string",
            "null"
          ]
        },
        "width": {
          "type": [
            "string",
            "null"
          ]
        },
        "height": {
          "type": [
            "string",
            "null"
          ]
        },
        "created_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "updated_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "deleted_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "required": [
        "id",
        "project_id",
        "research_collection_id",
        "audience_id",
        "page_id",
        "name",
        "description",
        "image",
        "width",
        "height",
        "created_at",
        "updated_at",
        "deleted_at"
      ],
      "title": "ScreenResource"
    }
  },
  "required": [
    "data"
  ]
}

{
  "data": {
    "id": 101,
    "project_id": 101,
    "research_collection_id": null,
    "audience_id": null,
    "page_id": null,
    "name": null,
    "description": null,
    "image": null,
    "width": null,
    "height": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null
  }
}

401

Unauthenticated

Content type: application/json.

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error overview."
    }
  },
  "required": [
    "message"
  ]
}

{
  "message": "The request could not be completed."
}

402

The Team is in read-only billing mode.

Content type: application/json.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "const": "subscription_required"
    },
    "mode": {
      "type": "string",
      "const": "blocked"
    },
    "message": {
      "type": "string",
      "example": "Your team is in read-only mode. Update billing to make changes."
    },
    "grace_period_ends_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  },
  "required": [
    "error",
    "mode",
    "message",
    "grace_period_ends_at"
  ]
}

{
  "error": "subscription_required",
  "mode": "blocked",
  "message": "Your team is in read-only mode. Update billing to make changes.",
  "grace_period_ends_at": null
}

403

Authorization error

Content type: application/json.

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Error overview."
    }
  },
  "required": [
    "message"
  ]
}

{
  "message": "The request could not be completed."
}

422

Validation error

Content type: application/json.

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Errors overview."
    },
    "errors": {
      "type": "object",
      "description": "A detailed description of each field that failed validation.",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "message",
    "errors"
  ]
}

{
  "message": "The request could not be completed.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}

429

Rate limit exceeded. Honor Retry-After before retrying.

Response headers:

{
  "Retry-After": {
    "description": "Seconds before retrying.",
    "schema": {
      "type": "integer"
    }
  }
}

Content type: application/json.

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "example": "Too Many Attempts."
    }
  },
  "required": [
    "message"
  ]
}

{
  "message": "Too Many Attempts."
}

500

The request failed.

Content type: application/json.

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "const": "Error uploading file"
    }
  },
  "required": [
    "error"
  ]
}

{
  "error": "Error uploading file"
}

See API conventions for error handling, rate limits, pagination, and uploads.

On this page