Apply all approved/edited suggestions — create or update tickets and milestones

POST

/projects/{id}/roadmap-check/{checkId}/apply

const url = 'https://example.com/api/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/roadmap-check/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/apply';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/roadmap-check/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

Iterates suggestions where approval_status ∈ (‘approved’,‘edited’) and dispatches per row by suggested_action: create_ticket, update_ticket, move_milestone, merge_duplicate, suggest_new_milestone, skip. New milestones are idempotent on title (case-insensitive). Fault-tolerant: a single row failure does not abort the rest.

Authorizations

bearerApiKey

Parameters

Path Parameters

required

string format: uuid

Project UUID

checkId

required

string format: uuid

Request Body

application/json

object

Responses

200

Apply summary and per-row outcomes

application/json

object

summary

required

object

created

integer

updated

integer

skipped

integer

failed

integer

milestones_created

integer

outcomes

required

Array<object>

object

suggestion_id

string format: uuid

status

string

Allowed values: applied failed skipped

action

string

Allowed values: create_ticket update_ticket skip merge_duplicate move_milestone suggest_new_milestone

ticket_id

string format: uuid

ticket_number

integer

milestone_id

string format: uuid

milestone_created

boolean

error

string

message

string

400

Project not linked to a billing tenant

401

Not authenticated

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number

reconnect

True if re-linking GitHub may fix the issue

boolean

403

Forbidden

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number