Skip to main content
PATCH
Change or end registered agent service

Authorizations

Authorization
string
header
required

Enter your API key in the format: sk_test_xxxxx or sk_live_xxxxx

Path Parameters

business_id
string
required

Body

application/json
status
enum<string>
required

Which update to perform. Discriminates the rest of the body.

Available options:
change_requested,
termination_requested
Example:

"change_requested"

registered_agent
object | null

New registered agent (when status=change_requested). Supply agent details to change to your own / a different RA; omit to switch to Palm-provided service.

reason
enum<string>

Why Palm RA service is being terminated (required when status=termination_requested).

Available options:
switching_providers,
business_dissolved,
business_offboarding,
other
Example:

"switching_providers"

reason_detail
string | null

Optional free-text context. Required by convention when reason is other.

Maximum string length: 500
Example:

"Moving RA service in-house effective end of quarter."

metadata
object

Optional metadata, round-tripped on the resulting work item.

Example:

Response

Registered agent update accepted

object
enum<string>
required

Object type identifier, always "registered_agent"

Available options:
registered_agent
Example:

"registered_agent"

business_id
string<uuid>
required

Business this RA-service state belongs to

Example:

"987e6543-e21a-45b6-c789-012345678901"

provider
enum<string> | null
required

Who provides RA service. palm when Palm provides service, external when the partner uses a different RA, null when no RA is tracked.

Available options:
palm,
external
Example:

"palm"

status
enum<string> | null
required

Lifecycle status of Palm-provided RA service. null when the partner uses an external RA or has never used Palm RA.

Available options:
pending,
active,
termination_requested,
terminated,
failed
Example:

"active"

jurisdiction
string | null
required

Jurisdiction (state) the RA service is for

Example:

"CA"

started_at
string<date-time> | null
required

ISO 8601 timestamp when the current service window started

Example:

"2026-05-29T10:30:00Z"

ended_at
string<date-time> | null
required

ISO 8601 timestamp when the most recent service window ended (null while active)

Example:

null

rejection_reason
string | null

Reason the most recent termination request was rejected by ops. Present only on the registered_agent.termination_failed webhook payload — null on every other event and on reads of the resource. After a rejection the business is back in active and the partner can re-submit a new termination request.

Example:

"State refused resignation form: GA requires a successor RA designation"

name
string | null

Name of the registered agent of record for the business in this jurisdiction. Populated when Palm provides RA service; null when not yet known or the partner uses an external RA.

Example:

"Acme Registered Agent Services, Inc."

address
object | null

Mailing address of the registered agent of record. Populated when Palm provides RA service; null when not yet known or the partner uses an external RA.