Send offer

Sends a pending offer to the customer. The offer must be in “pending” status.

POST/{id}/send

Authorization

AuthorizationBearer token · headerrequired

API token from the SIBI developer dashboard (developer.sibipro.com), sent as Authorization: Bearer <token>.

Scopes:write:offers

Path parameters

idstringrequired

The ID of the offer to send

Responses

200

Offer sent successfully

successbooleanrequired

Whether the offer was sent successfully

sentAtstring<date-time>required

Timestamp when the offer was sent

400

Bad request - Offer is not in a sendable state

codestringrequired

Error code indicating the type of error

messagestringrequired

Human-readable error message explaining what went wrong

detailsobject[]

Detailed validation errors when applicable

Show properties

Array of object

fieldstringrequired

errorstringrequired

401

Unauthorized - Missing or invalid authentication

codestringrequired

Error code indicating the type of error

messagestringrequired

Human-readable error message explaining what went wrong

detailsobject[]

Detailed validation errors when applicable

Show properties

Array of object

fieldstringrequired

errorstringrequired

403

Forbidden - Caller can view this offer but is not allowed to send it

codestringrequired

Error code indicating the type of error

messagestringrequired

Human-readable error message explaining what went wrong

detailsobject[]

Detailed validation errors when applicable

Show properties

Array of object

fieldstringrequired

errorstringrequired

404

Not found - Offer does not exist or caller is not allowed to view it

codestringrequired

Error code indicating the type of error

messagestringrequired

Human-readable error message explaining what went wrong

detailsobject[]

Detailed validation errors when applicable

Show properties

Array of object

fieldstringrequired

errorstringrequired

409

Offer is still being prepared (credit/upsells); retry once processing completes

codestringrequired

Error code indicating the type of error

messagestringrequired

Human-readable error message explaining what went wrong

detailsobject[]

Detailed validation errors when applicable

Show properties

Array of object

fieldstringrequired

errorstringrequired

500

Internal server error

codestringrequired

Error code indicating the type of error

messagestringrequired

Human-readable error message explaining what went wrong

detailsobject[]

Detailed validation errors when applicable

Show properties

Array of object

fieldstringrequired

errorstringrequired

Request

curl -X POST 'https://api.sibipro.com/prod/offers/string/send' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.sibipro.com/prod/offers/string/send", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

Response

{
  "success": true,
  "sentAt": "2024-01-20T12:00:00Z"
}

{
  "code": "OFFER_NOT_PENDING",
  "message": "Offer cannot be sent because it is not in \"pending\" status"
}

{
  "code": "OFFER_SENDING_ERROR",
  "message": "Error sending offer to customer"
}

{
  "code": "UNAUTHORIZED",
  "message": "Missing authentication token"
}

{
  "code": "INSUFFICIENT_SCOPE",
  "message": "The presented token is missing the `write:offers` scope, which this endpoint requires. Create a token with the scopes you need at https://developer.sibipro.com."
}

{
  "code": "FORBIDDEN",
  "message": "User does not have permission to send this offer"
}

{
  "code": "OFFER_NOT_FOUND",
  "message": "Offer not found"
}

{
  "code": "OFFER_PROCESSING",
  "message": "Offer is still being prepared. Please retry shortly."
}

{
  "code": "UPSELLS_GENERATING",
  "message": "Upsell generation for this offer is still in progress. Please retry shortly."
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "An unexpected error occurred"
}