POST
/projects/{project_gid}/project_briefsCreate a project brief
Creates a new project brief for a project. Supply the brief content in data, including text when you want to set the brief text, and use opt_fields to request additional properties in the response. A 201 response returns the complete newly created project brief record.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
opt_fieldsarray<string>optional
Comma-separated properties to include in the response, including nested properties. Supported values include `html_text`, `permalink_url`, `project`, `project.name`, `project.resource_subtype`, `text`, and `title`.
The project brief to create.
dataobjectoptional
The project brief resource to create, including its brief content.
201Returns the complete newly created project brief record.
dataobjectoptional
400Returned when a parameter is missing or malformed, or the request syntax is invalid.
errorsarray<object>optional
401Returned when the request does not include a valid authentication token.
errorsarray<object>optional
402Returned when the requested object or mutation exceeds the authenticated user's current premium level.
errorsarray<object>optional
403Returned when the authenticated user does not have access to the requested project or property.
errorsarray<object>optional
404Returned when the requested action is not known or the specified object does not exist.
errorsarray<object>optional
500Returned when a server-side problem prevents the request from completing.
errorsarray<object>optional
Error handling
A 400 is returned when the request is missing or malformed, a 401 when no valid authentication token is provided, and a 402 when the requested operation exceeds the current premium level. A 403 is returned when the authenticated user lacks access, a 404 when the project or requested action does not exist, and a 500 for a server-side failure. opt_fields must contain only supported properties such as text, title, or project.name.