Edits API

Sessions

5 endpoints.

POST/api/v1/edits/sessions

Open an edit session for one business the caller holds

Parameters

Name	In	Type	Description
`authorization`	header	`string \| null`
`X-Internal-Api-Key`	header	`string \| null`

Request bodyrequired

application/jsonOpenSessionBody

Field	Type	Description
`business_id`required	`string (uuid)`

Responses

201Successful Response

application/jsonSuccessResponse_EditSessionData_

Field Type Description

request_idrequired string

success true default true

datarequired

EditSessionData

EditSessionData fields

Field Type Description

idrequired string

business_idrequired string

company_namerequired string

client_idrequired string

statusrequired string

ended_reason string | null

created_atrequired string (date-time)

expires_atrequired string (date-time)

businessrequired

BusinessIdentityData

BusinessIdentityData fields

Field	Type	Description
`business_id`required	`string`
`company_name`required	`string`
`website_url`	`string \| null`
`custom_domain`	`string \| null`
`preview_domain`	`string \| null`
`city`	`string \| null`
`state`	`string \| null`
`launched`required	`boolean`

metadata

ResponseMetadata | null

ResponseMetadata fields

Field Type Description

pagination

PaginationMetadata | null

PaginationMetadata fields

Field	Type	Description
`limit`required	`integer`
`next_cursor`	`string \| null`
`prev_cursor`	`string \| null`
`has_more`required	`boolean`
`has_prev`	`boolean`	default false
`total_count`	`integer \| null`

status_counts

object | null

object | null fields

Map of string to integer

lifecycle_counts

LifecycleCounts | null

LifecycleCounts fields

Field	Type	Description
`lead`	`integer`	default 0
`prospect`	`integer`	default 0
`customer`	`integer`	default 0
`former_customer`	`integer`	default 0

classification_counts

ClassificationCounts | null

ClassificationCounts fields

Field	Type	Description
`signal`	`object`	object fields Nested object (not expanded)
`touch`	`object`	object fields Nested object (not expanded)
`stage`	`object`	object fields Nested object (not expanded)

meta

ResponseMeta | null

ResponseMeta fields

Field	Type	Description
`total`	`integer \| null`
`total_count`	`integer \| null`
`page`	`integer \| null`
`per_page`	`integer \| null`

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/edits/sessions/{session_id}

An edit session, and whether it is still open

Parameters

Name	In	Type
`session_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`
`X-Internal-Api-Key`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_EditSessionData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`EditSessionData`	EditSessionData fields EditSessionData, expanded above.
`metadata`	`ResponseMetadata \| null`	ResponseMetadata fields ResponseMetadata, expanded above.
`meta`	`ResponseMeta \| null`	ResponseMeta fields ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

POST/api/v1/edits/sessions/{session_id}/changesets

Check proposed changes and stage them as one changeset

Parameters

Name	In	Type
`session_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`
`X-Internal-Api-Key`	header	`string \| null`

Request bodyrequired

application/jsonStageChangesetBody

Field Type Description

summary string | null

idempotency_key string | null

itemsrequired

ChangeItemIn[]

min items 1 · max items 50

ChangeItemIn[] fields

Field	Type	Description
`entity`required	`string`	min length 1 · max length 64
`op`required	`string`	pattern ^(create\|update\|delete)$
`record_id`	`string \| null`
`fields`	`object`
`expected`	`object \| null`
`version`	`string \| null`

Responses

201Successful Response

application/jsonSuccessResponse_ChangesetData_

Field Type Description

request_idrequired string

success true default true

datarequired

ChangesetData

ChangesetData fields

Field	Type	Description
`id`required	`string`
`session_id`required	`string`
`business_id`required	`string`
`company_name`required	`string`
`client_id`required	`string`
`status`required	`string`
`summary`	`string \| null`
`created_at`required	`string (date-time)`
`applied_at`	`string (date-time) \| null`
`reverted_at`	`string (date-time) \| null`
`items`required	`ChangesetItemData[]`	ChangesetItemData[] fields ChangesetItemData (not expanded)
`replayed`	`boolean`	default false
`business`required	`BusinessIdentityData`	BusinessIdentityData fields BusinessIdentityData, expanded above.

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/edits/sessions/{session_id}/records/{entity}/{record_id}

One record in full, with its version (the profile is record_id 'profile')

Parameters

Name	In	Type
`session_id`required	path	`string (uuid)`
`entity`required	path	`string`
`record_id`required	path	`string`
`authorization`	header	`string \| null`
`X-Internal-Api-Key`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_RecordData_

Field Type Description

request_idrequired string

success true default true

datarequired

RecordData

RecordData fields

Field	Type	Description
`entity`required	`string`
`record_id`required	`string`
`label`required	`string`
`version`required	`string`
`record`required	`object`

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.

GET/api/v1/edits/sessions/{session_id}/snapshot

Everything the session's business has: the profile in full, other records trimmed

Parameters

Name	In	Type
`session_id`required	path	`string (uuid)`
`authorization`	header	`string \| null`
`X-Internal-Api-Key`	header	`string \| null`

Responses

200Successful Response

application/jsonSuccessResponse_SnapshotData_

Field Type Description

request_idrequired string

success true default true

datarequired

SnapshotData

SnapshotData fields

Field	Type	Description
`business_id`required	`string`
`company_name`required	`string`
`profile`required	`object`
`profile_version`required	`string`
`entities`required	`EntitySnapshotData[]`	EntitySnapshotData[] fields EntitySnapshotData (not expanded)
`business`required	`BusinessIdentityData`	BusinessIdentityData fields BusinessIdentityData, expanded above.

metadata

ResponseMetadata | null

ResponseMetadata fields

ResponseMetadata, expanded above.

meta

ResponseMeta | null

ResponseMeta fields

ResponseMeta, expanded above.

400Bad request
401Unauthorized
403Forbidden
404Not found
422Validation error
500Internal server error
503Service unavailable

Error bodies: ErrorResponse. See Errors.