Edits API

Changesets

5 endpoints.

GET/api/v1/edits/changesets/{changeset_id}

A changeset and its items

Parameters

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

Responses

200Successful Response

application/jsonSuccessResponse_ChangesetData_

Field Type Description

request_idrequired string

success true default true

datarequired

ChangesetData

ChangesetData fields

Field Type Description

idrequired string

session_idrequired string

business_idrequired string

company_namerequired string

client_idrequired string

statusrequired string

summary string | null

created_atrequired string (date-time)

applied_at string (date-time) | null

reverted_at string (date-time) | null

itemsrequired

ChangesetItemData[]

ChangesetItemData[] fields

ChangesetItemData (not expanded)

replayed boolean default false

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.

POST/api/v1/edits/changesets/{changeset_id}/apply

Apply a staged changeset's ticked items, each only if its value has not moved

Parameters

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

Request body

application/jsonApplyChangesetBody | null

Field	Type	Description
`item_ids`	`string (uuid)[] \| null`	string (uuid)[] \| null fields

Responses

200Successful Response

application/jsonSuccessResponse_ChangesetData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`ChangesetData`	ChangesetData fields ChangesetData, 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/changesets/{changeset_id}/discard

Drop a staged changeset

Parameters

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

Responses

200Successful Response

application/jsonSuccessResponse_ChangesetData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`ChangesetData`	ChangesetData fields ChangesetData, 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.

PATCH/api/v1/edits/changesets/{changeset_id}/items/{item_id}

Tick or untick one staged item

Parameters

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

Request bodyrequired

application/jsonItemSelectionBody

Field	Type	Description
`selected`required	`boolean`

Responses

200Successful Response

application/jsonSuccessResponse_ChangesetItemData_

Field Type Description

request_idrequired string

success true default true

datarequired

ChangesetItemData

ChangesetItemData fields

Field	Type	Description
`id`required	`string`
`position`required	`integer`
`entity`required	`string`
`entity_name`required	`string`
`op`required	`string`
`record_id`	`string \| null`
`record_label`	`string \| null`
`field_path`	`string \| null`
`label`	`string \| null`
`before_value`	`any \| null`
`after_value`	`any \| null`
`flags`	`object[]`	object[] fields
`selected`required	`boolean`
`status`required	`string`
`error`	`object \| null`

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/changesets/{changeset_id}/revert

Undo an applied changeset where nothing changed since

Parameters

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

Responses

200Successful Response

application/jsonSuccessResponse_ChangesetData_

Field	Type	Description
`request_id`required	`string`
`success`	`true`	default true
`data`required	`ChangesetData`	ChangesetData fields ChangesetData, 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.