Skip to content
Prokure Docs

Update company profile

PATCH
/api/v1/profile
curl --request PATCH \
  --url https://app.prokure.ca/api/v1/profile \
  --header 'Content-Type: application/json' \
  --data '{ "updates": [ { "field": "categories", "op": "add", "value": "example" } ] }'

Request Bodyrequired

Section titled “Request Bodyrequired”

Between 1 and 50 updates, applied in order. Each is independent: one being skipped or failing does not stop the rest, and the response reports both outcomes. Where two updates in the same request touch one field, the last wins.

Media typeapplication/json

Between 1 and 50 updates, applied in order. Each is independent: one being skipped or failing does not stop the rest, and the response reports both outcomes. Where two updates in the same request touch one field, the last wins.

object
updates
required
Array
>= 1 items <= 50 items
Any of:

Add or remove a single entry on a list field. Matching on remove is case-insensitive; adding an entry already on the list is reported as skipped, not an error.

object
field
required
string
Allowed values: categories geography certifications exclusions manufacturer_partners target_buyers
op
required
string
Allowed values: add remove
value
required
string
>= 1 characters <= 200 characters

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
profile
required
object
id
required
string
tenant_id
required
string
legal_name
required
string
business_number
required
Any of:
string
cage_code
required
Any of:
string
overview
required
Any of:
string
categories
required
Array<string>
geography
required
Array<string>
certifications
required
Array<string>
exclusions
required
Array<string>
business_role
required
Any of:
string
is_canadian_supplier
required
Any of:
boolean
manufacturer_partners
required
Array<string>
target_buyers
required
Array<string>
min_contract_value
required
Any of:
number
max_contract_value
required
Any of:
number
employee_count
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
applied
required
Array<object>
object
id
required
string
field
required
string
Allowed values: categories geography certifications exclusions manufacturer_partners target_buyers overview business_role is_canadian_supplier min_contract_value max_contract_value employee_count
value_before
required
value_after
required
cascade_summary
required
object
products_deactivated
required
integer
<= 9007199254740991
products_reactivated
required
integer
<= 9007199254740991
source
required
string
created_at
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$/
reverted
required
boolean
revertible
required
boolean
skipped
required
Array<object>
object
field
required
string
Allowed values: categories geography certifications exclusions manufacturer_partners target_buyers overview business_role is_canadian_supplier min_contract_value max_contract_value employee_count
op
required
string
Allowed values: add remove set
value
required
reason
required
string
Allowed values: already_present not_present already_set min_exceeds_max invalid_value error
message
required
string
Example
{
  "applied": [
    {
      "field": "categories"
    }
  ],
  "skipped": [
    {
      "field": "categories",
      "op": "add",
      "reason": "already_present"
    }
  ]
}

400

Section titled “400”

Default Response

Media typeapplication/json
object
error
required
string
Allowed values: unauthorized forbidden no_membership membership_disabled unverified_email identity_conflict insufficient_scope validation_failed not_found missing_file unsupported_type file_too_large empty_document unreadable_document context_doc_cap_reached rule_cap_reached already_reverted superseded already_exists partner_not_authorized invalid_import rate_limited internal
message
required
string
requestId
required
string
issues
Array
issue_count
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "error": "unauthorized"
}

401

Section titled “401”

Default Response

Media typeapplication/json
object
error
required
string
Allowed values: unauthorized forbidden no_membership membership_disabled unverified_email identity_conflict insufficient_scope validation_failed not_found missing_file unsupported_type file_too_large empty_document unreadable_document context_doc_cap_reached rule_cap_reached already_reverted superseded already_exists partner_not_authorized invalid_import rate_limited internal
message
required
string
requestId
required
string
issues
Array
issue_count
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "error": "unauthorized"
}

403

Section titled “403”

Default Response

Media typeapplication/json
object
error
required
string
Allowed values: unauthorized forbidden no_membership membership_disabled unverified_email identity_conflict insufficient_scope validation_failed not_found missing_file unsupported_type file_too_large empty_document unreadable_document context_doc_cap_reached rule_cap_reached already_reverted superseded already_exists partner_not_authorized invalid_import rate_limited internal
message
required
string
requestId
required
string
issues
Array
issue_count
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "error": "unauthorized"
}

429

Section titled “429”

Default Response

Media typeapplication/json
object
error
required
string
Allowed values: unauthorized forbidden no_membership membership_disabled unverified_email identity_conflict insufficient_scope validation_failed not_found missing_file unsupported_type file_too_large empty_document unreadable_document context_doc_cap_reached rule_cap_reached already_reverted superseded already_exists partner_not_authorized invalid_import rate_limited internal
message
required
string
requestId
required
string
issues
Array
issue_count
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "error": "unauthorized"
}

500

Section titled “500”

Default Response

Media typeapplication/json
object
error
required
string
Allowed values: unauthorized forbidden no_membership membership_disabled unverified_email identity_conflict insufficient_scope validation_failed not_found missing_file unsupported_type file_too_large empty_document unreadable_document context_doc_cap_reached rule_cap_reached already_reverted superseded already_exists partner_not_authorized invalid_import rate_limited internal
message
required
string
requestId
required
string
issues
Array
issue_count
integer
>= -9007199254740991 <= 9007199254740991
Example
{
  "error": "unauthorized"
}