Bloss Docs

Ask a creator to redo a task

Developers
POST
/brands/{brandId}/onboarding/submissions/{submissionId}/request-changes

Reopen a finished form or agreement task of an open submission, with a note, and email the creator. The submission goes back to in progress on that task, with a fresh deadline. Info tasks, unfinished tasks and closed submissions answer 409 conflict.

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
submissionId*string

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

Length1 <= length

Request Body

application/json
  1. body
taskId*string

A task id from the submission's tasks (GET .../submissions/{submissionId}).

Length1 <= length
note?|

What to change, up to 1,000 characters. The creator sees it.

Response Body

Success.

application/json
  1. response
id*string
status*string
taskId*string
curl -X POST 'https://example.com/api/v1/brands/string/onboarding/submissions/string/request-changes' \  -H 'Content-Type: application/json' \  -d '{  "taskId": "string"}'
{  "id": "string",  "status": "in_progress",  "taskId": "string"}

Was this page helpful?

Email a creator a reminder POST

Email the creator of a submission in progress a reminder to finish, now. One per submission every 12 hours: another within that answers 409 conflict (`details.reason` rate_limited).

List onboarding submissions GET

One row per creator going through an onboarding flow, finished or not, most recent activity first, as on Onboarding › Submissions. Filter by flow, link, current task, status (`overdue` is in progress with a task past its deadline), start day (brand time zone) and name, email or Discord. Set `withAnswers` to "true" to add each creator's form answers and agreement signatures (at most 25 per page); GET .../submissions/{submissionId} has one in full.