Projects

Update a project

Updates a project. Every field is optional, so you may send only the fields you would like to change; a field that is omitted keeps its current value. Pass brand_id to designate the project's own brand, or null to leave the project without one.

PATCH /api/v1/projects/{project}

Path parameters

Name Type Required Description
project integer Required

The numeric ID of the project.

Body parameters

Name Type Required Description
name string Optional

The new display name for the project. May be up to 120 characters.

brand_id integer Optional

The id of the brand to designate as the project's own brand, the one visibility is anchored against. The brand must belong to the project; it leaves any segments and sheds any ignored mark as it takes the role. Pass null to leave the project without an own brand.

Response

The project object

Field Type Description
id integer

The unique ID of the project.

organization_id integer

The ID of the organization that owns the project.

name string

The display name of the project.

brand_id integer

The ID of the project's own brand, or null while none has been designated.

created_at datetime

When the project was created.

updated_at datetime

When the project was last updated.