Generic deal update write-back

curl --request PATCH \
  --url https://{domain}/wp-json/sagescreen/v1/deal/{uuid} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "external_quote_id": "QU-00412"
}
'

{
  "success": true,
  "data": {
    "deal_id": 1042,
    "deal_uuid": "3d55ae7a-af8b-46c1-ae1c-09afa207ac7f",
    "updated": {
      "external_quote_id": "QU-00412"
    }
  }
}

{
  "code": "empty_body",
  "message": "Request body must be a non-empty JSON object",
  "data": {
    "status": 400
  }
}

{
  "code": "invalid_api_key",
  "message": "Invalid or missing API key",
  "data": {
    "status": 401
  }
}

{
  "code": "deal_not_found",
  "message": "Deal not found",
  "data": {
    "status": 404
  }
}

{
  "code": "key_not_configured",
  "message": "API key not configured on server",
  "data": {
    "status": 500
  }
}

PATCH

deal

{uuid}

curl --request PATCH \
  --url https://{domain}/wp-json/sagescreen/v1/deal/{uuid} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "external_quote_id": "QU-00412"
}
'

{
  "success": true,
  "data": {
    "deal_id": 1042,
    "deal_uuid": "3d55ae7a-af8b-46c1-ae1c-09afa207ac7f",
    "updated": {
      "external_quote_id": "QU-00412"
    }
  }
}

{
  "code": "empty_body",
  "message": "Request body must be a non-empty JSON object",
  "data": {
    "status": 400
  }
}

{
  "code": "invalid_api_key",
  "message": "Invalid or missing API key",
  "data": {
    "status": 401
  }
}

{
  "code": "deal_not_found",
  "message": "Deal not found",
  "data": {
    "status": 404
  }
}

{
  "code": "key_not_configured",
  "message": "API key not configured on server",
  "data": {
    "status": 500
  }
}

Authorizations

X-API-Key

string

header

required

SageScreen API key stored in ss_zapier_api_key option

Path Parameters

uuid

string<uuid>

required

Deal UUID (deal_uuid meta value)

Example:

"3d55ae7a-af8b-46c1-ae1c-09afa207ac7f"

Body

application/json

Arbitrary key-value pairs. Post-level fields (post_title, post_status, post_content) update the post; all others become post-meta. Reserved keys deal_uuid and deal_id are silently ignored.

Response

Fields updated

success

boolean

data

object

Show child attributes

Public API

Internal API

Generic deal update write-back

Authorizations

Path Parameters

Body

Response