Provisioning API · Internal testing only
Update a sequencer account
const url = 'https://api.builders.ac/api/provisioning/v1alpha1/provider-accounts/pra_01jsdqrf91f949ybjwh90xde9g';const options = { method: 'PATCH', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"username":"outbound@northwind-labs.com","url":"https://northwind.sequencer.example","api_key":"sk-northwind-EXAMPLE-0000000000000000","password":"example-password-not-a-real-one","totp_secret":"JBSWY3DPEHPK3PXPEXAMPLE0","sequencer_workspace":"Northwind Outbound"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://api.builders.ac/api/provisioning/v1alpha1/provider-accounts/pra_01jsdqrf91f949ybjwh90xde9g \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "username": "outbound@northwind-labs.com", "url": "https://northwind.sequencer.example", "api_key": "sk-northwind-EXAMPLE-0000000000000000", "password": "example-password-not-a-real-one", "totp_secret": "JBSWY3DPEHPK3PXPEXAMPLE0", "sequencer_workspace": "Northwind Outbound" }'Rotate the api_key or other credentials, or correct the username or URL. The resulting credentials are verified with the sequencer before anything is stored; a refusal leaves the stored credentials untouched.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Provider account TypeIDs are accepted case-insensitively. Responses use canonical lowercase.
Request Bodyrequired
Section titled “Request Bodyrequired”Every field is optional; the sequencer is asked to verify the resulting credentials before anything is stored. provider cannot change and external_id is immutable: sending either answers 422 and 409 respectively.
object
A corrected legacy browser-login username. Omit to keep the stored one. Plusvibe authentication uses api_key.
Required for bison, whose API lives at a per-customer base URL; must be a public https or http URL. Rejected for every other provider.
A plaintext secret. Prefer SealedValue when request logs or intermediaries are not trusted with plaintext.
object
An ASCII-armored age v1 file. Response values are sealed to the API Key used for the request; request values are sealed to a recipient published by GET /encryption-keys.
A plaintext secret. Prefer SealedValue when request logs or intermediaries are not trusted with plaintext.
object
An ASCII-armored age v1 file. Response values are sealed to the API Key used for the request; request values are sealed to a recipient published by GET /encryption-keys.
A plaintext secret. Prefer SealedValue when request logs or intermediaries are not trusted with plaintext.
object
An ASCII-armored age v1 file. Response values are sealed to the API Key used for the request; request values are sealed to a recipient published by GET /encryption-keys.
The workspace whose credentials this changes. It may be omitted only while the account has a single workspace, which is then the one changed; once it has several — discovery adds one row per workspace the key reaches — naming one is required and omitting it answers 422.
Responses
Section titled “Responses”Provider account updated. Secrets are never included.
object
Canonical lowercase TypeID.
The sequencer behind a provider account.
The login the upload worker signs in with; null when the sequencer authenticates by key alone.
The per-customer base URL, for providers that have one.
Workspace names known at the sequencer: the one registered plus any discovered from the key. PUT /domains/{dom}/sequencer takes one of these.
The outcome of the last credential check with the sequencer; null when the account has never been checked.
When the credentials were last verified with the sequencer.
Opaque and case-sensitive; unique per owning Account within the provider-account resource type.
Example
{ "id": "pra_01jsdqrf91f949ybjwh90xde9g", "object": "provider_account", "provider": "instantly", "username": "outbound@northwind-labs.com", "url": "https://northwind.sequencer.example", "sequencer_workspaces": [ "Northwind Outbound", "Northwind EU" ], "validation_status": "valid", "validated_at": "2026-04-16T11:02:37Z", "external_id": "crm-8421", "created_at": "2026-04-15T09:15:04Z", "updated_at": "2026-04-16T11:02:37Z"}Headers
Section titled “Headers”The id of this request, echoed on every response and repeated in the correlation_id member of a problem body. Quote it in support requests.
Authentication required. The example shows authentication_required; this status is also answered with invalid_api_key. Branch on code, not on the status.
object
Extensible enum. Branch on this, never on title. New codes may appear at any time, so treat an unrecognised one as its HTTP status; GET /problems lists every code this version can answer with, and GET /problems/{code} resolves one.
object
Example
{ "type": "https://api.builders.ac/api/provisioning/v1alpha1/problems/authentication_required", "title": "Authentication required", "status": 401, "detail": "Provide an active Provisioning API Key as a Bearer token.", "code": "authentication_required", "retryable": false, "correlation_id": "9f1c2b7a-3d5e-4c81-9a77-2f6b0e4d51c3"}Headers
Section titled “Headers”The id of this request, echoed on every response and repeated in the correlation_id member of a problem body. Quote it in support requests.
Account inactive. The example shows account_inactive; this status is also answered with insufficient_proof. Branch on code, not on the status.
object
Extensible enum. Branch on this, never on title. New codes may appear at any time, so treat an unrecognised one as its HTTP status; GET /problems lists every code this version can answer with, and GET /problems/{code} resolves one.
object
Example
{ "type": "https://api.builders.ac/api/provisioning/v1alpha1/problems/account_inactive", "title": "Account inactive", "status": 403, "detail": "This account is inactive.", "code": "account_inactive", "retryable": false, "correlation_id": "9f1c2b7a-3d5e-4c81-9a77-2f6b0e4d51c3"}Headers
Section titled “Headers”The id of this request, echoed on every response and repeated in the correlation_id member of a problem body. Quote it in support requests.
Not found. The example shows not_found.
object
Extensible enum. Branch on this, never on title. New codes may appear at any time, so treat an unrecognised one as its HTTP status; GET /problems lists every code this version can answer with, and GET /problems/{code} resolves one.
object
Example
{ "type": "https://api.builders.ac/api/provisioning/v1alpha1/problems/not_found", "title": "Not found", "status": 404, "detail": "The requested resource was not found.", "code": "not_found", "retryable": false, "correlation_id": "9f1c2b7a-3d5e-4c81-9a77-2f6b0e4d51c3"}Headers
Section titled “Headers”The id of this request, echoed on every response and repeated in the correlation_id member of a problem body. Quote it in support requests.
External_id cannot change, or the sequencer account is also held by another Account and its credentials cannot be changed here.
object
Extensible enum. Branch on this, never on title. New codes may appear at any time, so treat an unrecognised one as its HTTP status; GET /problems lists every code this version can answer with, and GET /problems/{code} resolves one.
object
object
Extensible enum. Branch on this, never on title. New codes may appear at any time, so treat an unrecognised one as its HTTP status; GET /problems lists every code this version can answer with, and GET /problems/{code} resolves one.
object
Examples
external_id is immutable
{ "type": "https://api.builders.ac/api/provisioning/v1alpha1/problems/external_id_immutable", "title": "external_id is immutable", "status": 409, "detail": "external_id is set once, at creation, and cannot be changed. Create a new resource under the new external_id instead.", "code": "external_id_immutable", "retryable": false, "correlation_id": "9f1c2b7a-3d5e-4c81-9a77-2f6b0e4d51c3"}Provider account is in use
{ "type": "https://api.builders.ac/api/provisioning/v1alpha1/problems/provider_account_in_use", "title": "Provider account is in use", "status": 409, "detail": "A domain is still bound to this sequencer account. Remove the binding with DELETE /domains/{dom}/sequencer first, then retry.", "code": "provider_account_in_use", "retryable": false, "correlation_id": "9f1c2b7a-3d5e-4c81-9a77-2f6b0e4d51c3"}Headers
Section titled “Headers”The id of this request, echoed on every response and repeated in the correlation_id member of a problem body. Quote it in support requests.
Either the request body is invalid (validation_error, with errors by field), a sealed value could not be opened (invalid_sealed_value), or the sequencer refused the credentials (provider_credentials_invalid, with validation naming the checks that failed). Nothing was stored.
object
Extensible enum. Branch on this, never on title. New codes may appear at any time, so treat an unrecognised one as its HTTP status; GET /problems lists every code this version can answer with, and GET /problems/{code} resolves one.
object
What the sequencer said, with nothing secret in it.
object
A sentence a person can act on.
object
Workspace names the key can reach, when the sequencer listed them; helps correct a wrong sequencer_workspace.
object
Extensible enum. Branch on this, never on title. New codes may appear at any time, so treat an unrecognised one as its HTTP status; GET /problems lists every code this version can answer with, and GET /problems/{code} resolves one.
object
Examples
Provider credentials rejected
{ "type": "https://api.builders.ac/api/provisioning/v1alpha1/problems/provider_credentials_invalid", "title": "Provider credentials rejected", "status": 422, "detail": "The sequencer rejected these credentials; `validation` lists the checks that failed. Correct them and retry with a new Idempotency-Key.", "code": "provider_credentials_invalid", "retryable": false, "correlation_id": "9f1c2b7a-3d5e-4c81-9a77-2f6b0e4d51c3", "validation": { "category": "invalid_credentials", "message": "The sequencer rejected the API Key.", "checks": [ { "key": "api_key", "status": "passed", "category": "invalid_credentials", "message": "The sequencer did not accept this key." } ], "sequencer_workspaces": [ "Northwind Outbound", "Northwind EU" ] }}Headers
Section titled “Headers”The id of this request, echoed on every response and repeated in the correlation_id member of a problem body. Quote it in support requests.
Rate limit exceeded. The example shows rate_limit_exceeded.
object
Extensible enum. Branch on this, never on title. New codes may appear at any time, so treat an unrecognised one as its HTTP status; GET /problems lists every code this version can answer with, and GET /problems/{code} resolves one.
object
Example
{ "type": "https://api.builders.ac/api/provisioning/v1alpha1/problems/rate_limit_exceeded", "title": "Rate limit exceeded", "status": 429, "detail": "Too many requests were made for this policy.", "code": "rate_limit_exceeded", "retryable": true, "correlation_id": "9f1c2b7a-3d5e-4c81-9a77-2f6b0e4d51c3", "retry_after": "2026-04-15T09:16:04Z"}Headers
Section titled “Headers”The id of this request, echoed on every response and repeated in the correlation_id member of a problem body. Quote it in support requests.
The sequencer could not be reached to verify the credentials (provider_unreachable), or platform encryption keys are unavailable (encryption_keys_unavailable). Nothing was stored; retry later with a new Idempotency-Key.
object
Extensible enum. Branch on this, never on title. New codes may appear at any time, so treat an unrecognised one as its HTTP status; GET /problems lists every code this version can answer with, and GET /problems/{code} resolves one.
object
object
Extensible enum. Branch on this, never on title. New codes may appear at any time, so treat an unrecognised one as its HTTP status; GET /problems lists every code this version can answer with, and GET /problems/{code} resolves one.
object
object
Extensible enum. Branch on this, never on title. New codes may appear at any time, so treat an unrecognised one as its HTTP status; GET /problems lists every code this version can answer with, and GET /problems/{code} resolves one.
object
Examples
Provider unreachable
{ "type": "https://api.builders.ac/api/provisioning/v1alpha1/problems/provider_unreachable", "title": "Provider unreachable", "status": 503, "detail": "The sequencer could not be reached to verify these credentials. Nothing was stored; retry later.", "code": "provider_unreachable", "retryable": true, "correlation_id": "9f1c2b7a-3d5e-4c81-9a77-2f6b0e4d51c3"}Encryption keys unavailable
{ "type": "https://api.builders.ac/api/provisioning/v1alpha1/problems/encryption_keys_unavailable", "title": "Encryption keys unavailable", "status": 503, "detail": "Encryption key discovery is temporarily unavailable. Retry later.", "code": "encryption_keys_unavailable", "retryable": true, "correlation_id": "9f1c2b7a-3d5e-4c81-9a77-2f6b0e4d51c3"}Headers
Section titled “Headers”The id of this request, echoed on every response and repeated in the correlation_id member of a problem body. Quote it in support requests.