Bloss Docs

Delete an unused agreement template

Developers
DELETE
/brands/{brandId}/onboarding/agreements/{agreementId}

Delete an agreement template nothing uses. While a flow's task uses it, or creators have signed it, it answers 409 conflict with details.flows and details.submissions: pick another agreement in those flows, or archive it to keep signed records. Preview with dryRun.

Authorization

bearerAuth onboarding:write
headerAuthorizationBearer <token>

Personal access token. Scopes: account:read, creator:read, creator:earnings, managed:read, coach:read, brand:read, creators:read, videos:read, analytics:read, onboarding:read, onboarding:signatures, engagement:read, support:read, integrations:read, payouts:read, funds:read, billing:read, groups:write, videos:write, onboarding:write, sync:write, payouts:write.

Scope: onboarding:write

Path Parameters

brandId*string

A brand id from GET /me or GET /creator/brands.

Length1 <= length
agreementId*string

An id from GET /brands/{brandId}/onboarding/agreements.

Length1 <= length

Query Parameters

dryRun?string

"true": run every check and return { dryRun: true, wouldChange } without changing anything.

Value in"true""false"

Response Body

Success.

application/json
  1. response
id*string
deleted*boolean
curl -X DELETE 'https://example.com/api/v1/brands/string/onboarding/agreements/string'
{  "id": "string",  "deleted": true}

Was this page helpful?

List the brand's team GET

Everyone on Settings › Team, oldest first: each member's admin access and tier, and whether they also have a creator profile. Plus the admin invitations not yet accepted or expired. Members removed from the brand are left out.

Change an agreement template PATCH

Save an agreement's name or text, remove its uploaded PDF (it goes back to its text), or archive or unarchive it. Text changes are a draft: creators sign them once a flow using the agreement is published. Creators who already signed keep the version they signed.