Can't be less than 1 and more than 128 fields.
If value of a field explicitly passed as NULL, it will delete a current value of the field." }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "item_field_#1":"new field value" } } } } }, "required":true }, "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":{ "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "item_field_#1":"new field value" } } } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "examples":{ "identifier is not provided":{ "summary":"identifier is not provided", "description":"identifier is not provided", "value":{ "errorCode":400116, "message":"Missing parameter: identifier" } }, "type is not provided":{ "summary":"type is not provided", "description":"type is not provided", "value":{ "errorCode":400116, "message":"Missing parameter: type" } }, "itemId isn't UUID":{ "summary":"itemId isn't UUID", "description":"itemId isn't UUID", "value":{ "errorCode":429002, "message":"Item id is invalid: 123456L" } }, "sender shouldn't be provided":{ "summary":"sender shouldn't be provided", "description":"sender shouldn't be provided", "value":{ "errorCode":400117, "message":"For type [TYPE] sender shouldn't be specified" } }, "sender should be provided":{ "summary":"sender should be provided", "description":"sender should be provided", "value":{ "errorCode":400117, "message":"For type [TYPE] sender should be specified" } }, "incorrect field value is provided":{ "summary":"incorrect field value is provided", "description":"incorrect field value is provided", "value":{ "errorCode":300109, "message":"Invalid field value for
Can't be less than 1 and more than 128 fields.
If value of a field explicitly passed as NULL, it will delete a current value of the field." }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "item_field_#1":"new field value" } } } } }, "required":true }, "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":[ { "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "item_field_#1":"new field value" }, { "__id":"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f", "item_field_#1":"some value", "item_field_#2":42 } ] } } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "examples":{ "identifier is not provided":{ "summary":"identifier is not provided", "description":"identifier is not provided", "value":{ "errorCode":400116, "message":"Missing parameter: identifier" } }, "type is not provided":{ "summary":"type is not provided", "description":"type is not provided", "value":{ "errorCode":400116, "message":"Missing parameter: type" } }, "sender shouldn't be provided":{ "summary":"sender shouldn't be provided", "description":"sender shouldn't be provided", "value":{ "errorCode":400117, "message":"For type [TYPE] sender shouldn't be specified" } }, "sender should be provided":{ "summary":"sender should be provided", "description":"sender should be provided", "value":{ "errorCode":400117, "message":"For type [TYPE] sender should be specified" } }, "incorrect field value is provided":{ "summary":"incorrect field value is provided", "description":"incorrect field value is provided", "value":{ "errorCode":300109, "message":"Invalid field value for
Can't be less than 1 and more than 128 items.
Identifiers of items are not allowed in a body." } }, "examples":{ "Request example":{ "summary":"Request example", "value":[ { "item_field_#1":"some value", "item_field_#2":42 }, { "item_field_#1":"some value" } ] } } } }, "required":true }, "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":[ { "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "item_field_#1":"some value" }, { "__id":"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f", "item_field_#1":"some value", "item_field_#2":42 } ] } } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "examples":{ "identifier is not provided":{ "summary":"identifier is not provided", "description":"identifier is not provided", "value":{ "errorCode":400116, "message":"Missing parameter: identifier" } }, "type is not provided":{ "summary":"type is not provided", "description":"type is not provided", "value":{ "errorCode":400116, "message":"Missing parameter: type" } }, "sender shouldn't be provided":{ "summary":"sender shouldn't be provided", "description":"sender shouldn't be provided", "value":{ "errorCode":400117, "message":"For type [TYPE] sender shouldn't be specified" } }, "sender should be provided":{ "summary":"sender should be provided", "description":"sender should be provided", "value":{ "errorCode":400117, "message":"For type [TYPE] sender should be specified" } }, "item ids shouldn't be passed":{ "summary":"item ids shouldn't be passed", "description":"item ids shouldn't be passed", "value":{ "errorCode":429002, "message":"Item ids shouldn't be passed" } }, "incorrect field value is provided":{ "summary":"incorrect field value is provided", "description":"incorrect field value is provided", "value":{ "errorCode":300109, "message":"Invalid field value for
Can't be less than 1 and more than 128 items.
New item IDs are not allowed.
Items without existing ids in are not allowed
If value of a field explicitly passed as NULL, it will delete a current value of the field." } }, "examples":{ "Request example":{ "summary":"Request example", "value":[ { "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "item_field_#1":"new value", "item_field_#2":null }, { "__id":"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f", "item_field_#1":"new value", "item_field_#2":42 } ] } } } }, "required":true }, "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":[ { "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "item_field_#1":"new value", "item_field_#3":"old value" }, { "__id":"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f", "item_field_#1":"new value", "item_field_#2":42, "item_field_#3":"old value" } ] } } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "examples":{ "identifier is not provided":{ "summary":"identifier is not provided", "description":"identifier is not provided", "value":{ "errorCode":400116, "message":"Missing parameter: identifier" } }, "type is not provided":{ "summary":"type is not provided", "description":"type is not provided", "value":{ "errorCode":400116, "message":"Missing parameter: type" } }, "sender shouldn't be provided":{ "summary":"sender shouldn't be provided", "description":"sender shouldn't be provided", "value":{ "errorCode":400117, "message":"For type [TYPE] sender shouldn't be specified" } }, "sender should be provided":{ "summary":"sender should be provided", "description":"sender should be provided", "value":{ "errorCode":400117, "message":"For type [TYPE] sender should be specified" } }, "item ids should be passed":{ "summary":"item ids should be passed", "description":"item ids should be passed", "value":"{\"errorCode\": 429002, \"message\": \"Ids should be presented for an every item: {\"item_field_#1\": \"new value\"}\"}" }, "incorrect field value is provided":{ "summary":"incorrect field value is provided", "description":"incorrect field value is provided", "value":{ "errorCode":300109, "message":"Invalid field value for
- no profile with a given personId
- no custom attribute with a given listName
- no instance of a list with a given listName
- no items with given itemIds in a list
If an instance of a list doesn't exist for a person, the list instance will be created.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "type":"object", "description":"Items to append.
Can't be less than 1 and more than 128 items.
Item IDs are not allowed." } }, "examples":{ "Request example":{ "summary":"Request example", "value":[ { "field1":"field value" }, { "field1":"field value" } ] } } } }, "required":true }, "responses":{ "200":{ "description":"Items appended", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":[ { "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "field1":"field value" }, { "__id":"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f", "field1":"field value" } ] } } } } }, "400":{ "description":"Bad request:
- empty body
- __id fields passed
- fields undefined in the list schema passed
- unexpected type of a field value passed
- size of the resulting list exceeds 128 items
- no profile with a given personId
- no custom attribute with a given list name
- no profile with a given personId
- no custom attribute with a given listName
- no instance of a list with a given listName
- no items with given itemIds in a list
If an instance of a list doesn't exist for a person, the list instance will be created.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"itemId", "in":"path", "description":"Identifier of an item to replace.
Identifier should be UUID.
Value of __id-field passed in a body will be replaced by the current value.
If an item with a given identifier doesn't exist, it will be created.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "description":"Item fields for replace.
Can't be less than 1 and more than 128 fields.
If value of a field explicitly passed as NULL, it will delete a current value of the field." }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "field1":"new field value" } } } } }, "required":true }, "responses":{ "200":{ "description":"Item fields replaced", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":[ { "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "field1":"new field value" }, { "__id":"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f", "field1":"field value" } ] } } } } }, "400":{ "description":"Bad request:
- empty body
- passed itemId can't be parsed as UUID
- fields undefined in the list schema passed
- unexpected type of a field value passed
- size of the resulting list exceeds 128 items
- no profile with a given personId
- no custom attribute with a given listName
Missing fields will be preserved.
Returns all items of the updated list.", "operationId":"deprecated-update-list-item", "parameters":[ { "name":"personId", "in":"path", "description":"Person's internal ID.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"integer", "format":"int64", "minimum":1 } }, { "name":"listName", "in":"path", "description":"Name given to a list.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"itemId", "in":"path", "description":"Identifier of an item to update.
Identifier should be UUID.
Value of __id-field passed in a body will be replaced by the current value.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "description":"Item fields for update.
Can't be less than 1 and more than 128 fields.
If value of a field explicitly passed as NULL, it will delete a current value of the field." }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "field1":"new field value" } } } } }, "required":true }, "responses":{ "200":{ "description":"Item fields updated", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":[ { "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "field1":"new field value", "field2":"old field value" }, { "__id":"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f", "field1":"field value", "field2":"field value" } ] } } } } }, "400":{ "description":"Bad request:
- empty body
- passed itemId can't be parsed as UUID
- fields undefined in the list schema passed
- unexpected type of a field value passed
- no profile with a given personId
- no custom attribute with a given listName
- no instance of a list with a given listName
- no items with a given itemId in a list
- no profile with a given personId
- no custom attributes with given listNames
- no instances of list with given listNames
- no profile with a given personId
- no custom attribute with a given listName
- no instance of a list with a given listName
- no items with given itemIds in a list
If an instance of a list doesn't exist for a person, the list instance will be created.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "type":"object", "description":"Items data for replace.
Can't be less than 1 and more than 128 items.
Identifiers of items are not allowed in a body." } }, "examples":{ "Request example":{ "summary":"Request example", "value":[ { "field1":"new field value" }, { "field1":"new field value" } ] } } } }, "required":true }, "responses":{ "200":{ "description":"Items are replaced", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":[ { "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "field1":"field value" }, { "__id":"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f", "field1":"field value" } ] } } } } }, "400":{ "description":"Bad request:
- empty body
- __id fields passed
- fields undefined in the list schema passed
- unexpected type of a field value passed
- size of the resulting list exceeds 128 items
- no profile with a given personId
- no custom attributes with given listNames
Missing items and fields will be preserved.
Returns all items of the updated list.", "operationId":"deprecated-update-list", "parameters":[ { "name":"personId", "in":"path", "description":"Person's internal ID.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"integer", "format":"int64", "minimum":1 } }, { "name":"listName", "in":"path", "description":"Name given to a list.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "type":"object", "description":"Items data for update.
Can't be less than 1 and more than 128 items.
New item IDs are not allowed.
Items without existing ids in are not allowed
If value of a field explicitly passed as NULL, it will delete a current value of the field." } }, "examples":{ "Request example":{ "summary":"Request example", "value":[ { "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "field1":"new field value" }, { "__id":"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f", "field1":"new field value" } ] } } } }, "required":true }, "responses":{ "200":{ "description":"Items updated", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":[ { "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "field1":"new field value", "field2":"old field value" }, { "__id":"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f", "field1":"new field value", "field2":"old field value" }, { "__id":"1d543ae8-957d-4fe6-b0f4-ad3ce1eb5bbf", "field1":"field value" } ] } } } } }, "400":{ "description":"Bad request:
- empty body
- no __id fields passed
- fields undefined in the list schema passed
- unexpected type of a field value passed
- no profile with a given personId
- no custom attribute with a given listName
- no instance of a list with a given listName
- no items with given itemIds in a list
Each event in the batch must reference an existing person profile and a predefined event type. If an event references a person identifier that does not match any existing profile, a new `CUSTOMER` profile will automatically be created for that identifier.
**Note**: The entire batch will fail to import if any single event fails due to missing event type, properties, etc.", "operationId":"send-custom-events", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventBatchResourceRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":[ { "definitionId":"addToCart", "occurredTime":"2025-03-17T13:00:27.864Z", "identifier":{ "id":"example@gmail.com", "type":"EMAIL", "sender":"75320" }, "properties":{ "transactionId":"my-transaction-1", "fromPromoCampaign":true, "totalCost":100, "itemsInCart":[ { "itemId":1, "price":25, "quantity":3, "inStockSince":"2023-11-17T15:47:50.413Z", "category":"clothes" }, { "itemId":2, "price":25, "quantity":1, "inStockSince":"2023-12-17T15:47:50.413Z", "category":"shoes" } ] } }, { "definitionId":"addToCart", "occurredTime":"2025-03-17T11:30:00.109Z", "identifier":{ "id":"15", "type":"ID" }, "properties":{ "transactionId":"my-transaction-2", "fromPromoCampaign":false, "totalCost":1539, "itemsInCart":[ { "itemId":7, "price":39, "quantity":1, "inStockSince":"2024-09-21T10:12:50.209Z", "category":"shirt" }, { "itemId":8, "price":250, "quantity":6, "inStockSince":"2024-09-20T09:21:30.483Z", "category":"jacket" } ] } } ] } } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventBatchResourceRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":[ { "definitionId":"addToCart", "occurredTime":"2025-03-17T13:00:27.864Z", "identifier":{ "id":"example@gmail.com", "type":"EMAIL", "sender":"75320" }, "properties":{ "transactionId":"my-transaction-1", "fromPromoCampaign":true, "totalCost":100, "itemsInCart":[ { "itemId":1, "price":25, "quantity":3, "inStockSince":"2023-11-17T15:47:50.413Z", "category":"clothes" }, { "itemId":2, "price":25, "quantity":1, "inStockSince":"2023-12-17T15:47:50.413Z", "category":"shoes" } ] } }, { "definitionId":"addToCart", "occurredTime":"2025-03-17T11:30:00.109Z", "identifier":{ "id":"15", "type":"ID" }, "properties":{ "transactionId":"my-transaction-2", "fromPromoCampaign":false, "totalCost":1539, "itemsInCart":[ { "itemId":7, "price":39, "quantity":1, "inStockSince":"2024-09-21T10:12:50.209Z", "category":"shirt" }, { "itemId":8, "price":250, "quantity":6, "inStockSince":"2024-09-20T09:21:30.483Z", "category":"jacket" } ] } } ] } } }, "text/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventBatchResourceRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":[ { "definitionId":"addToCart", "occurredTime":"2025-03-17T13:00:27.864Z", "identifier":{ "id":"example@gmail.com", "type":"EMAIL", "sender":"75320" }, "properties":{ "transactionId":"my-transaction-1", "fromPromoCampaign":true, "totalCost":100, "itemsInCart":[ { "itemId":1, "price":25, "quantity":3, "inStockSince":"2023-11-17T15:47:50.413Z", "category":"clothes" }, { "itemId":2, "price":25, "quantity":1, "inStockSince":"2023-12-17T15:47:50.413Z", "category":"shoes" } ] } }, { "definitionId":"addToCart", "occurredTime":"2025-03-17T11:30:00.109Z", "identifier":{ "id":"15", "type":"ID" }, "properties":{ "transactionId":"my-transaction-2", "fromPromoCampaign":false, "totalCost":1539, "itemsInCart":[ { "itemId":7, "price":39, "quantity":1, "inStockSince":"2024-09-21T10:12:50.209Z", "category":"shirt" }, { "itemId":8, "price":250, "quantity":6, "inStockSince":"2024-09-20T09:21:30.483Z", "category":"jacket" } ] } } ] } } }, "application/*+json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventBatchResourceRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":[ { "definitionId":"addToCart", "occurredTime":"2025-03-17T13:00:27.864Z", "identifier":{ "id":"example@gmail.com", "type":"EMAIL", "sender":"75320" }, "properties":{ "transactionId":"my-transaction-1", "fromPromoCampaign":true, "totalCost":100, "itemsInCart":[ { "itemId":1, "price":25, "quantity":3, "inStockSince":"2023-11-17T15:47:50.413Z", "category":"clothes" }, { "itemId":2, "price":25, "quantity":1, "inStockSince":"2023-12-17T15:47:50.413Z", "category":"shoes" } ] } }, { "definitionId":"addToCart", "occurredTime":"2025-03-17T11:30:00.109Z", "identifier":{ "id":"15", "type":"ID" }, "properties":{ "transactionId":"my-transaction-2", "fromPromoCampaign":false, "totalCost":1539, "itemsInCart":[ { "itemId":7, "price":39, "quantity":1, "inStockSince":"2024-09-21T10:12:50.209Z", "category":"shirt" }, { "itemId":8, "price":250, "quantity":6, "inStockSince":"2024-09-20T09:21:30.483Z", "category":"jacket" } ] } } ] } } } } }, "responses":{ "202":{ "description":"Accepted" }, "400":{ "description":"Bad request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ProblemDetailsResponse" }, "examples":{ "Invalid JSON request body":{ "summary":"Invalid JSON request body", "description":"Occurs when the request body is either missing, null, or not properly structured as a JSON array, preventing successful processing of the request.", "value":{ "errors":[ { "index":-1, "code":400500, "message":"Invalid request. Please ensure the request body is a properly structured JSON array." } ], "traceId":"
**Note**: New profiles can only be created for the following identifier types: `PHONE`, `EMAIL`, or `EXTERNAL_ID`.", "required":false, "style":"form", "explode":true, "schema":{ "type":"boolean" } } ], "requestBody":{ "content":{ "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventResourceRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "properties":{ "transactionId":"my-transaction-1", "fromPromoCampaign":true, "totalCost":100, "itemsInCart":[ { "itemId":1, "price":25, "quantity":3, "inStockSince":"2023-11-17T15:47:50.4136517Z", "category":"clothes" }, { "itemId":2, "price":25, "quantity":1, "inStockSince":"2023-12-17T15:47:50.4138054Z", "category":"shoes" } ] } } } } }, "application/json":{ "schema":{ "$ref":"#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventResourceRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "properties":{ "transactionId":"my-transaction-1", "fromPromoCampaign":true, "totalCost":100, "itemsInCart":[ { "itemId":1, "price":25, "quantity":3, "inStockSince":"2023-11-17T15:47:50.4136517Z", "category":"clothes" }, { "itemId":2, "price":25, "quantity":1, "inStockSince":"2023-12-17T15:47:50.4138054Z", "category":"shoes" } ] } } } } }, "text/json":{ "schema":{ "$ref":"#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventResourceRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "properties":{ "transactionId":"my-transaction-1", "fromPromoCampaign":true, "totalCost":100, "itemsInCart":[ { "itemId":1, "price":25, "quantity":3, "inStockSince":"2023-11-17T15:47:50.4136517Z", "category":"clothes" }, { "itemId":2, "price":25, "quantity":1, "inStockSince":"2023-12-17T15:47:50.4138054Z", "category":"shoes" } ] } } } } }, "application/*+json":{ "schema":{ "$ref":"#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventResourceRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "properties":{ "transactionId":"my-transaction-1", "fromPromoCampaign":true, "totalCost":100, "itemsInCart":[ { "itemId":1, "price":25, "quantity":3, "inStockSince":"2023-11-17T15:47:50.4136517Z", "category":"clothes" }, { "itemId":2, "price":25, "quantity":1, "inStockSince":"2023-12-17T15:47:50.4138054Z", "category":"shoes" } ] } } } } } } }, "responses":{ "201":{ "description":"Successfully created", "content":{ "text/plain":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventResourceResponse" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "eventId":"EFDB662A-F0BD-4064-8F49-16C0C1C48AD2", "definitionId":"addToCart", "occurredTime":"2024-05-17T15:47:50.4139152Z", "properties":{ "transactionId":"my-transaction-1", "fromPromoCampaign":true, "totalCost":100, "itemsInCart":[ { "itemId":1, "price":25, "quantity":3, "inStockSince":"2023-11-17T15:47:50.4136517Z", "category":"clothes" }, { "itemId":2, "price":25, "quantity":1, "inStockSince":"2023-12-17T15:47:50.4138054Z", "category":"shoes" } ] }, "metadata":{ "source":"API" } } } } }, "application/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventResourceResponse" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "eventId":"EFDB662A-F0BD-4064-8F49-16C0C1C48AD2", "definitionId":"addToCart", "occurredTime":"2024-05-17T15:47:50.4139152Z", "properties":{ "transactionId":"my-transaction-1", "fromPromoCampaign":true, "totalCost":100, "itemsInCart":[ { "itemId":1, "price":25, "quantity":3, "inStockSince":"2023-11-17T15:47:50.4136517Z", "category":"clothes" }, { "itemId":2, "price":25, "quantity":1, "inStockSince":"2023-12-17T15:47:50.4138054Z", "category":"shoes" } ] }, "metadata":{ "source":"API" } } } } }, "text/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventResourceResponse" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "eventId":"EFDB662A-F0BD-4064-8F49-16C0C1C48AD2", "definitionId":"addToCart", "occurredTime":"2024-05-17T15:47:50.4139152Z", "properties":{ "transactionId":"my-transaction-1", "fromPromoCampaign":true, "totalCost":100, "itemsInCart":[ { "itemId":1, "price":25, "quantity":3, "inStockSince":"2023-11-17T15:47:50.4136517Z", "category":"clothes" }, { "itemId":2, "price":25, "quantity":1, "inStockSince":"2023-12-17T15:47:50.4138054Z", "category":"shoes" } ] }, "metadata":{ "source":"API" } } } } } } }, "400":{ "description":"Invalid resource representation" }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "$ref":"#/components/responses/ApiException404" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "Basic":[] }, { "APIKeyHeader":[] }, { "IBSSOTokenHeader":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage", "people:use", "web:sdk" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":250, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/peopleevents/2/definitions":{ "get":{ "tags":[ "customer-engagement", "people", "events" ], "summary":"List Event Definitions", "description":"Retrieve a paginated list of event definitions, including standard, custom, and template definitions. Use query parameters to filter by category (`External`, `Person`, `Channel`, `Product`, `Template`) or search by definition ID, title, or description. Results can be ordered by definition ID or title.", "operationId":"list-event-definitions", "parameters":[ { "name":"offset", "in":"query", "description":"A pagination parameter that specifies the number of records to skip before starting to return results.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "maximum":2147483647, "minimum":0 } }, { "name":"limit", "in":"query", "description":"A pagination parameter that specifies the maximum number of records to return in a single response.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "maximum":2147483647, "minimum":0 } }, { "name":"orderType", "in":"query", "description":"Defines the sort direction for the results.
**Note**: If `orderField` is not provided, this parameter will not have any effect.", "required":false, "style":"form", "explode":true, "schema":{ "allOf":[ { "$ref":"#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.DefinitionOrderDirection" } ] } }, { "name":"orderField", "in":"query", "description":"Specifies the field by which the results should be ordered.
**Note**: If `orderType` is not provided, ordering will not work.", "required":false, "style":"form", "explode":true, "schema":{ "allOf":[ { "$ref":"#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.DefinitionOrderField" } ] } }, { "name":"category", "in":"query", "description":"Filters results by one or more event definition categories.", "required":false, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "allOf":[ { "$ref":"#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventDefinitionCategory" } ] }, "uniqueItems":true } }, { "name":"searchText", "in":"query", "description":"Text used for searching event definitions by definition ID, title, or description.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionResource" } }, "examples":{ "Response example":{ "summary":"Response example", "value":[ { "isInternalDefinition":false, "category":"external", "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] }, { "isInternalDefinition":false, "category":"external", "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] }, { "isInternalDefinition":false, "category":"external", "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } ] } } }, "text/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionResource" } }, "examples":{ "Response example":{ "summary":"Response example", "value":[ { "isInternalDefinition":false, "category":"external", "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] }, { "isInternalDefinition":false, "category":"external", "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] }, { "isInternalDefinition":false, "category":"external", "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } ] } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"No matches" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "Basic":[] }, { "APIKeyHeader":[] }, { "IBSSOTokenHeader":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage", "people:read" ] }, "post":{ "tags":[ "customer-engagement", "people", "events" ], "summary":"Create Event Definition", "description":"Create a new custom event definition either from scratch or from a template. When creating from scratch, specify a unique definition ID (alphanumeric only, max `36` characters), title, description, and up to `120` fields. When using a template, only provide the template ID and optional additional fields—the title, description, and default fields are inherited from the template. Supports various field types including `String`, `Boolean`, `DateTime`, `Numeric`, `Decimal`, and `List` (with nested object schema).", "operationId":"create-event-definition", "requestBody":{ "content":{ "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionCreateResource" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } }, "application/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionCreateResource" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } }, "text/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionCreateResource" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } }, "application/*+json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionCreateResource" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } } }, "required":true }, "responses":{ "201":{ "description":"Successfully created", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionResource" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "isInternalDefinition":false, "category":"external", "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } }, "text/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionResource" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "isInternalDefinition":false, "category":"external", "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } } } }, "400":{ "description":"Invalid resource representation" }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "409":{ "description":"Conflict. Definition with such 'definitionId' has already existed." }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "Basic":[] }, { "APIKeyHeader":[] }, { "IBSSOTokenHeader":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage" ] } }, "/peopleevents/2/definitions/{definitionId}":{ "get":{ "tags":[ "customer-engagement", "people", "events" ], "summary":"Get Event Definition", "description":"Retrieve complete details of a specific event definition, including its fields, data types, category, and whether it's a standard or custom definition. Useful for understanding the schema before sending events or for validating your event data structure.", "operationId":"get-event-definition", "parameters":[ { "name":"definitionId", "in":"path", "description":"Event definition identifier.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionResource" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "isInternalDefinition":false, "category":"external", "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } }, "text/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionResource" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "isInternalDefinition":false, "category":"external", "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"No matches" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "Basic":[] }, { "APIKeyHeader":[] }, { "IBSSOTokenHeader":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage", "people:read" ] }, "post":{ "tags":[ "customer-engagement", "people", "events" ], "summary":"Update Event Definition", "description":"Update an existing custom event definition by adding new fields or modifying the title and description. Only supports additive changes—you can add new fields but **cannot** remove existing fields or change their types. This ensures backward compatibility with historical events. Standard (internal) definitions and template-inherited properties cannot be modified.", "operationId":"update-event-definition", "parameters":[ { "name":"definitionId", "in":"path", "description":"Event definition identifier.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionUpdateResource" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } }, "application/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionUpdateResource" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } }, "text/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionUpdateResource" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } }, "application/*+json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionUpdateResource" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionResource" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "isInternalDefinition":false, "category":"external", "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } }, "text/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionResource" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "isInternalDefinition":false, "category":"external", "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } } } }, "400":{ "description":"Invalid resource representation" }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"No matches" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "Basic":[] }, { "APIKeyHeader":[] }, { "IBSSOTokenHeader":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage" ] } }, "/peopleevents/1/export":{ "post":{ "tags":[ "customer-engagement", "people", "events" ], "summary":"Submit event export request", "description":"Events export allows you to asynchronously export People Events data to a compressed file or multiple files in your AWS S3 bucket.\n\nRefer to [product documentation](https://www.infobip.com/docs/people/events#events-in-external-systems) for detailed information on configuring AWS S3 for export, export file format and event data schema. \n\n**Throttling**\n\nYou can have maximum of 72 hours worth of export requests in progress at one time.\n\n", "operationId":"create-events-export-request", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/a1a8ff0e2d4e8815c87f131be18d5198cdc635a778df6b963f0f0a4b59822f94.ExportRequestBody" }, "examples":{ "Export events to an s3 bucket":{ "summary":"Export events to an s3 bucket", "value":{ "roleArn":"arn:aws:iam::account:role/role-name-with-path", "bucket":"exported-events-bucket", "region":"EU_CENTRAL_1", "startTime":"2022-01-01T00:00:00.000+0000", "endTime":"2022-01-01T01:00:00.000+0000" } }, "Export events to a directory of an s3 bucket":{ "summary":"Export events to a directory of an s3 bucket", "value":{ "roleArn":"arn:aws:iam::account:role/role-name-with-path", "bucket":"exported-events-bucket", "region":"EU_CENTRAL_1", "directoryPath":"dir/subdir/", "startTime":"2022-01-01T00:00:00.000+0000", "endTime":"2022-01-01T01:00:00.000+0000" } }, "Export events with definitionId matching filter":{ "summary":"Export events with definitionId matching filter", "value":{ "roleArn":"arn:aws:iam::account:role/role-name-with-path", "bucket":"exported-events-bucket", "region":"EU_CENTRAL_1", "startTime":"2022-01-01T00:00:00.000+0000", "endTime":"2022-01-01T01:00:00.000+0000", "definitionIdList":[ "person*Flow", "emailOpened", "pageView" ] } }, "Export events enriched with moments information":{ "summary":"Export events enriched with moments information", "value":{ "roleArn":"arn:aws:iam::account:role/role-name-with-path", "bucket":"exported-events-bucket", "region":"EU_CENTRAL_1", "startTime":"2022-01-01T00:00:00.000+0000", "endTime":"2022-01-01T01:00:00.000+0000", "enrichWithMomentsInfo":true } } } } }, "required":true }, "responses":{ "202":{ "description":"Accepted", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/a389f65d9a8b852c007cdb5a24c983f5c2dc5fa67bb655d3284926dc5c3ce095.ExportResponseBody" }, "examples":{ "Response for a valid event export request":{ "summary":"Response for a valid event export request", "value":{ "requestId":"4c959f87-9a45-4e16-bcd2-7f2a79e95067" } } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException" } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"token", "replenishRate":1, "requestedTokens":1, "burstCapacity":5 } ] } }, "/peopleevents/1/export/status/{requestId}":{ "get":{ "tags":[ "customer-engagement", "people", "events" ], "summary":"Check status of event export request", "description":"Retrieves the status of a previously submitted data export request by the request ID.", "operationId":"get-events-export-request-status", "parameters":[ { "name":"requestId", "in":"path", "description":"Request ID (unique identifier) of a previously submitted data export request.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "writeOnly":true } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/a389f65d9a8b852c007cdb5a24c983f5c2dc5fa67bb655d3284926dc5c3ce095.StatusResponseBody" }, "examples":{ "Request has been submitted but not processed.":{ "summary":"Request has been submitted but not processed.", "value":{ "requestId":"4c959f87-9a45-4e16-bcd2-7f2a79e95067", "status":"SUBMITTED" } }, "Request is in progress.":{ "summary":"Request is in progress.", "value":{ "requestId":"4c959f87-9a45-4e16-bcd2-7f2a79e95067", "status":"IN_PROGRESS" } }, "Request has been completed successfully.":{ "summary":"Request has been completed successfully.", "value":{ "requestId":"4c959f87-9a45-4e16-bcd2-7f2a79e95067", "status":"COMPLETED_SUCCESSFULLY" } }, "Request is completed with no events exported.":{ "summary":"Request is completed with no events exported.", "value":{ "requestId":"4c959f87-9a45-4e16-bcd2-7f2a79e95067", "status":"COMPLETED_SUCCESSFULLY", "message":"0 events found for the time period queried." } }, "There has been an error while processing the request, request is queued to be retried.":{ "summary":"There has been an error while processing the request, request is queued to be retried.", "value":{ "requestId":"4c959f87-9a45-4e16-bcd2-7f2a79e95067", "status":"FAILED_AWAITING_RETRY", "message":"Exception caught while trying to push file to S3." } }, "Request failed after maximum retries.":{ "summary":"Request failed after maximum retries.", "value":{ "requestId":"4c959f87-9a45-4e16-bcd2-7f2a79e95067", "status":"FAILED_AFTER_MAX_RETRIES", "message":"Exception caught while trying to push file to S3." } }, "Request is waiting to be cancelled.":{ "summary":"Request is waiting to be cancelled.", "value":{ "requestId":"4c959f87-9a45-4e16-bcd2-7f2a79e95067", "status":"SUBMITTED", "message":"Cancellation pending, cancellation request received at 2022-01-01T00:00:00.000Z" } }, "Request has been cancelled.":{ "summary":"Request has been cancelled.", "value":{ "requestId":"4c959f87-9a45-4e16-bcd2-7f2a79e95067", "status":"CANCELLED_BY_CUSTOMER", "message":"Cancellation complete, cancellation request received at 2022-01-01T00:00:00.000Z" } } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException" } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"token", "replenishRate":1, "requestedTokens":1, "burstCapacity":5 } ] } }, "/peopleevents/1/export/{requestId}":{ "delete":{ "tags":[ "customer-engagement", "people", "events" ], "summary":"Asynchronous cancellation of an event export request", "description":"Requests asynchronous cancellation of a previously submitted data export request by the request ID.", "operationId":"cancel-events-export-request", "parameters":[ { "name":"requestId", "in":"path", "description":"Request ID (unique identifier) of a previously submitted data export request.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "writeOnly":true } } ], "responses":{ "202":{ "description":"Accepted", "content":{ "application/json":{} } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException" } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"token", "replenishRate":1, "requestedTokens":1, "burstCapacity":1 } ] } }, "/peopleevents/1/export/definitions":{ "get":{ "tags":[ "customer-engagement", "people", "events" ], "summary":"Get list of event definitions", "description":"Retrieves a list of all available event definitions, including custom events. \nThe event definitions can be then used as a filter in the \n[Event Export API](https://www.infobip.com/docs/api#customer-engagement/people/create-events-export-request).", "operationId":"get-events-definitions-for-export", "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/a389f65d9a8b852c007cdb5a24c983f5c2dc5fa67bb655d3284926dc5c3ce095.DefinitionsResponseBody" }, "examples":{ "Response for getting a list of `definitionId`s":{ "summary":"Response for getting a list of `definitionId`s", "value":{ "definitionIdList":[ "emailOpened", "pageView", "personEnteredFlow", "customEvent" ] } } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException" } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"token", "replenishRate":1, "requestedTokens":1, "burstCapacity":5 } ] } }, "/people/3/segments":{ "get":{ "tags":[ "customer-engagement", "people", "segments" ], "summary":"Get a list of segments", "description":"Use this method to get a list of segments.", "externalDocs":{ "description":"Learn more about Segments and its use cases.", "url":"https://www.infobip.com/docs/people/manage-audience#segments" }, "operationId":"get-segments", "parameters":[ { "name":"page", "in":"query", "description":"Zero-based page index (0..N).", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "default":0 } }, { "name":"size", "in":"query", "description":"The size of the page to be returned.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "default":20, "maximum":1000, "minimum":1 } }, { "name":"sort", "in":"query", "description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", "required":false, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string", "example":"name,DESC" } } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PageSegmentResponseDto" } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:read", "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "post":{ "tags":[ "customer-engagement", "people", "segments" ], "summary":"Create a segment", "description":"Use this method to create a segment.", "externalDocs":{ "description":"Learn more about Segments and its use cases.", "url":"https://www.infobip.com/docs/people/manage-audience#segments" }, "operationId":"create-segment", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.SegmentCreateDto" } } }, "required":true }, "responses":{ "201":{ "description":"Created", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.SegmentResponseDto" } } } }, "400":{ "$ref":"#/components/responses/ApiError400" }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/people/3/segments/{segmentId}":{ "get":{ "tags":[ "customer-engagement", "people", "segments" ], "summary":"Get a segment", "description":"Use this method to get a segment by ID.", "externalDocs":{ "description":"Learn more about Segments and its use cases.", "url":"https://www.infobip.com/docs/people/manage-audience#segments" }, "operationId":"get-segment", "parameters":[ { "name":"segmentId", "in":"path", "description":"A unique segment identifier.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"integer", "format":"int64", "description":"A unique segment identifier.", "example":42 }, "example":42 } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.SegmentResponseDto" } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:read", "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "put":{ "tags":[ "customer-engagement", "people", "segments" ], "summary":"Update a segment", "description":"Use this method to update a segment.", "externalDocs":{ "description":"Learn more about Segments and its use cases.", "url":"https://www.infobip.com/docs/people/manage-audience#segments" }, "operationId":"update-segment", "parameters":[ { "name":"segmentId", "in":"path", "description":"A unique segment identifier.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"integer", "format":"int64", "description":"A unique segment identifier.", "example":42 }, "example":42 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.SegmentUpdateDto" } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.SegmentResponseDto" } } } }, "400":{ "$ref":"#/components/responses/ApiError400" }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "delete":{ "tags":[ "customer-engagement", "people", "segments" ], "summary":"Delete a segment", "description":"Use this method to delete a segment by ID.", "externalDocs":{ "description":"Learn more about Segments and its use cases.", "url":"https://www.infobip.com/docs/people/manage-audience#segments" }, "operationId":"delete-segment", "parameters":[ { "name":"segmentId", "in":"path", "description":"A unique segment identifier.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"integer", "format":"int64", "description":"A unique segment identifier.", "example":42 }, "example":42 } ], "responses":{ "204":{ "description":"No Content" }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/people/3/segments/{segmentId}/persons":{ "get":{ "tags":[ "customer-engagement", "people", "segments" ], "summary":"Get persons in a segment", "description":"Use this method to get persons in a segment by ID.", "externalDocs":{ "description":"Learn more about Segments and its use cases.", "url":"https://www.infobip.com/docs/people/manage-audience#segments" }, "operationId":"get-segment-persons", "parameters":[ { "name":"segmentId", "in":"path", "description":"A unique segment identifier.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"integer", "format":"int64", "description":"A unique segment identifier.", "example":42 }, "example":42 }, { "name":"page", "in":"query", "description":"Zero-based page index (0..N).", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "default":0 } }, { "name":"size", "in":"query", "description":"The size of the page to be returned.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "default":20, "maximum":1000, "minimum":1 } }, { "name":"sort", "in":"query", "description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", "required":false, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string", "example":"name,DESC" } } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PagePersonV3" } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:read", "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/moments/1/flows/{campaignId}/participants":{ "post":{ "tags":[ "customer-engagement", "moments", "flow" ], "summary":"Add participants to flow", "description":"Use this endpoint to add participants to a flow, accommodating anywhere from 1 to 1000 persons. \n When participants are added, their profiles in People are automatically created, updated or merged based on the identifiers provided.
\n If identifiers are unique, a new profile is created.
\n If identifiers match an existing profile, then that profile is updated.
\n If identifiers refer to multiple existing profiles or are not unique within the request, profiles are merged.
\n To prevent unwanted merges, ensure each participant's identifiers \n (
identifyBy, externalId and contactInformation) are unique.",
"operationId":"add-flow-participants",
"parameters":[
{
"name":"campaignId",
"in":"path",
"description":"Unique identifier of the flow that participant will be added to.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"integer",
"format":"int64"
},
"example":200000000000001
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.AddFlowParticipantsRequest"
},
"examples":{
"Add participants to Flow":{
"summary":"Add participants to Flow",
"description":"Add participants to Flow",
"value":{
"participants":[
{
"identifyBy":{
"identifier":"370329180020364",
"type":"FACEBOOK"
}
},
{
"identifyBy":{
"identifier":"test@infobip.com",
"type":"EMAIL"
},
"variables":{
"orderNumber":1167873391
}
},
{
"identifyBy":{
"identifier":"test2@infobip.com",
"type":"EMAIL"
},
"variables":{
"orderNumber":1595299041
},
"person":{
"externalId":"optional_external_person_id",
"customAttributes":{
"Contract Expiry":"2023-04-01",
"Company":"Infobip"
},
"contactInformation":{
"email":[
{
"address":"test@infobip.com"
}
]
}
}
}
],
"notifyUrl":"https://mydomain/callback",
"callbackData":"Callback Data"
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.AddFlowParticipantsResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"operationId":"03f2d474-0508-46bf-9f3d-d8e2c28adaea"
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.BadRequestResponse"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"description":"Bad request",
"value":{
"type":"about:blank",
"title":"Bad Request",
"status":400,
"detail":"Failed to read request",
"instance":"/moments/1/flows/200000000000001/participants"
}
},
"Invalid number of participants":{
"summary":"Invalid number of participants",
"description":"Invalid number of participants",
"value":{
"errorCode":"400",
"errorMessage":"Number of participants must be between 1 and 1000. Received: 1200"
}
},
"Mandatory fields absent":{
"summary":"Mandatory fields absent",
"description":"Mandatory fields absent",
"value":{
"errorCode":"400",
"errorMessage":"Mandatory fields are absent: [participants]"
}
},
"Validation errors":{
"summary":"Validation errors",
"description":"Validation errors",
"value":{
"errorCode":"400",
"errorMessage":"Field participants.[0].identifyBy.type must not be null or unsupported value"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.ExceptionResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"errorCode":"40401",
"errorMessage":"Could not find active flow for campaign 200000000000001"
}
}
}
}
}
},
"429":{
"description":"Too Many Requests",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/8a96177a069f927b552e6f478d6833812472502f930c109564e4f89f3264faaa.ApiException"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"requestError":{
"serviceException":{
"messageId":"TOO_MANY_REQUESTS",
"text":"Too many requests"
}
}
}
}
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"flow:use",
"flow:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/moments/1/flows/{campaignId}/participants/report":{
"get":{
"tags":[
"customer-engagement",
"moments",
"flow"
],
"summary":"Get a report on participants added to flow",
"description":"Use this API endpoint to fetch a report to confirm that all persons have been successfully added to the flow.\n Please note that report is stored for 30 days.",
"operationId":"get-flow-participants-added-report",
"parameters":[
{
"name":"campaignId",
"in":"path",
"description":"Unique identifier of the flow that participant will be added to.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"integer",
"format":"int64"
},
"example":200000000000001
},
{
"name":"operationId",
"in":"query",
"description":"Unique identifier of the operation.",
"required":true,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"03f2d474-0508-46bf-9f3d-d8e2c28adaea"
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.FlowParticipantsReportResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"operationId":"03f2d474-0508-46bf-9f3d-d8e2c28adaea",
"campaignId":200000000000001,
"callbackData":"Callback Data",
"participants":[
{
"identifyBy":{
"identifier":"test@infobip.com",
"type":"EMAIL"
},
"status":"ACCEPTED"
},
{
"identifyBy":{
"identifier":"test2@infobip.com",
"type":"EMAIL"
},
"status":"REJECTED",
"errorReason":"REJECTED_INVALID_CONTACT"
}
]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"flow:use",
"flow:read",
"flow:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/communication/1/flows/{campaignId}/participants":{
"post":{
"tags":[
"customer-engagement",
"moments",
"flow"
],
"summary":"Add Person to Flow",
"description":"Creates or updates a person and adds it to Flow",
"operationId":"add-people-to-flow",
"parameters":[
{
"name":"campaignId",
"in":"path",
"description":"Unique identifier of the flow that person will be added to",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"integer",
"format":"int64"
},
"example":10159347
},
{
"name":"phone",
"in":"query",
"description":"Person's phone number",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":19123456789
},
{
"name":"email",
"in":"query",
"description":"Person's email address",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"janewilliams@example.com"
},
{
"name":"externalId",
"in":"query",
"description":"Unique ID for the person from an external system",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"8edb24b5-0319-48cd-a1d9-1e8bc5d577ab"
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.FlowPersonRequest"
}
}
}
},
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.ExceptionResponse"
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.ExceptionResponse"
}
}
}
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"deprecated":true,
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"flow:use",
"flow:manage"
],
"x-deprecationInformation":{
"deprecation":"2023-10-25T00:00:00.777+0000",
"sunset":"2024-10-25T12:00:00.777+0000",
"successorOperationId":"add-flow-participants"
},
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"delete":{
"tags":[
"customer-engagement",
"moments",
"flow"
],
"summary":"Remove person from flow",
"description":"Removes a participant with given identifier from the flow.",
"operationId":"remove-people-from-flow",
"parameters":[
{
"name":"campaignId",
"in":"path",
"description":"Unique identifier of the flow that person will be removed from.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"integer",
"format":"int64"
},
"example":10159347
},
{
"name":"phone",
"in":"query",
"description":"Person's phone number.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":19123456789
},
{
"name":"email",
"in":"query",
"description":"Person's email address.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"janewilliams@example.com"
},
{
"name":"externalId",
"in":"query",
"description":"Unique ID for the person from an external system.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"8edb24b5-0319-48cd-a1d9-1e8bc5d577ab"
}
],
"responses":{
"200":{
"description":"OK"
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.ExceptionResponse"
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/900634339512041dd9c6cd5c4ad62d6cf43ea57e0548f5deeceb9f79d92b92f0.ExceptionResponse"
}
}
}
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"flow:use",
"flow:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/forms/1/forms":{
"get":{
"tags":[
"customer-engagement",
"moments",
"forms"
],
"summary":"Get forms",
"description":"Use this method to get a list of forms.",
"operationId":"get-forms",
"parameters":[
{
"name":"offset",
"in":"query",
"description":"Skip first {offset} forms of the list.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":0
},
"example":60
},
{
"name":"limit",
"in":"query",
"description":"The maximum number of returned forms. Maximum value is `100`.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":25
},
"example":30
},
{
"name":"formType",
"in":"query",
"description":"The type of returned forms.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"enum":[
"OPT_IN",
"OPT_OUT",
"FACEBOOK",
"LIVECHAT",
"APPLE"
]
},
"example":"APPLE"
},
{
"name":"formStatus",
"in":"query",
"description":"The status of returned forms.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.FormStatus"
},
"example":"ACTIVE"
}
],
"responses":{
"200":{
"description":"Successful Response",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ApiFormListDto"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"forms":[
{
"id":"f23f0f7c-9898-4feb-8f21-5afe2c29db7e",
"name":"Test form",
"elements":[
{
"component":"TEXT",
"fieldId":"first_name",
"personField":"firstName",
"label":"First Name",
"isRequired":false,
"isHidden":false,
"additionalConfiguration":{},
"validationRules":{
"maxLength":255,
"sample":"James",
"forbiddenSymbols":[
"^",
"&",
"<",
">",
"\"",
"/",
"\\",
"\n",
"\r",
":",
"(",
")",
"{",
"}",
"=",
";",
"#",
"|",
"+",
"%",
"*",
"?",
"[",
"]"
]
},
"placeholder":"First Name"
},
{
"component":"TEXT",
"fieldId":"last_name",
"personField":"lastName",
"label":"Last Name",
"isRequired":false,
"isHidden":false,
"additionalConfiguration":{},
"validationRules":{
"maxLength":255,
"sample":"James",
"forbiddenSymbols":[
"^",
"&",
"<",
">",
"\"",
"/",
"\\",
"\n",
"\r",
":",
"(",
")",
"{",
"}",
"=",
";",
"#",
"|",
"+",
"%",
"*",
"?",
"[",
"]"
]
},
"placeholder":"Last Name"
},
{
"component":"TEXT",
"fieldId":"company",
"personField":"267ce64a-1a26-4326-9036-6384696f39c8",
"label":"Company",
"isRequired":false,
"isHidden":false,
"additionalConfiguration":{},
"validationRules":{
"maxLength":1000,
"sample":"Lorem ipsum"
},
"placeholder":"Company"
},
{
"component":"TEXT",
"fieldId":"country",
"personField":"country",
"label":"Country",
"isRequired":false,
"isHidden":false,
"additionalConfiguration":{},
"validationRules":{
"maxLength":1000,
"sample":"Lorem ipsum"
},
"placeholder":"Country"
},
{
"component":"EMAIL",
"fieldId":"email",
"personField":"email",
"label":"Email Address",
"isRequired":true,
"isHidden":false,
"additionalConfiguration":{},
"validationRules":{
"maxLength":1000,
"pattern":"(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])",
"sample":"email@example.com"
},
"placeholder":"Email"
},
{
"component":"TEXTAREA",
"fieldId":"business_needs",
"label":"Business Needs",
"isRequired":false,
"isHidden":false,
"additionalConfiguration":{},
"validationRules":{
"maxLength":3000,
"sample":"Lorem ipsum ..."
},
"placeholder":""
},
{
"component":"TEXT",
"fieldId":"offer_id",
"label":"OfferId",
"isRequired":false,
"isHidden":false,
"additionalConfiguration":{},
"validationRules":{
"maxLength":1000,
"sample":"Lorem ipsum"
},
"placeholder":"OfferId"
},
{
"component":"TEXT",
"fieldId":"plan_id",
"label":"PlanId",
"isRequired":false,
"isHidden":false,
"additionalConfiguration":{},
"validationRules":{
"maxLength":1000,
"sample":"Lorem ipsum"
},
"placeholder":"PlanId"
},
{
"component":"TEXT",
"fieldId":"subscription_id",
"label":"SubscriptionId",
"isRequired":false,
"isHidden":false,
"additionalConfiguration":{},
"validationRules":{
"maxLength":1000,
"sample":"Lorem ipsum"
},
"placeholder":"SubscriptionId"
},
{
"component":"TEXT",
"fieldId":"Tenant_id",
"label":"TenantId",
"isRequired":false,
"isHidden":false,
"additionalConfiguration":{},
"validationRules":{
"maxLength":1000,
"sample":"Lorem ipsum"
},
"placeholder":"TenantId"
},
{
"component":"SUBMIT_BUTTON",
"label":"Submit"
}
],
"createdAt":"2022-07-11T06:38:12.757+0000",
"updatedAt":"2022-07-11T06:45:12.826+0000",
"resubmitEnabled":true,
"formType":"OPT_IN",
"formStatus":"ACTIVE"
},
{
"id":"7370b24c-9788-4a52-a6a4-047cecbe2df2",
"name":"test",
"elements":[
{
"component":"EMAIL",
"fieldId":"email",
"personField":"email",
"label":"Email",
"isRequired":false,
"isHidden":false,
"additionalConfiguration":{},
"validationRules":{
"maxLength":1000,
"pattern":"(?:[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*|\"(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21\\x23-\\x5b\\x5d-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])*\")@(?:(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?|\\[(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?|[a-z0-9-]*[a-z0-9]:(?:[\\x01-\\x08\\x0b\\x0c\\x0e-\\x1f\\x21-\\x5a\\x53-\\x7f]|\\\\[\\x01-\\x09\\x0b\\x0c\\x0e-\\x7f])+)\\])",
"sample":"email@example.com"
},
"placeholder":"Email"
},
{
"component":"SUBMIT_BUTTON",
"label":"Submit"
}
],
"createdAt":"2022-06-15T13:21:38.195+0000",
"updatedAt":"2022-06-15T13:21:46.286+0000",
"resubmitEnabled":true,
"formType":"OPT_IN",
"formStatus":"ACTIVE"
}
],
"offset":0,
"limit":25,
"total":2
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/082acced121042a63992bde26d4dd141353f7b2633c33f797139d71d4bef2a93.ApiFormListDto"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":"This endpoint performs a semantic search over an AI assistant's indexed documents based on configured guidelines. It then generates a response using the LLM connected to the assistant.
The \"use shared history\" feature allowing an AI assistant to utilize the agent's conversation history, is only available if used together with [Infobip AI agents](https://www.infobip.com/docs/ai-agents).", "operationId":"query-ai-assistant", "parameters":[ { "name":"assistantId", "in":"path", "description":"Unique identifier of the AI assistant to query.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"1ad5a87f-a6cd-3cc0-58c5-317db01440fd" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/2a53d681c9399f766b0cfff54e0469d04419b36fc1603e6db03e69cc8ad55f34.SimpleAiAssistantQuery" } } }, "required":true }, "responses":{ "200":{ "description":"AI Assistant response retrieved successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/2a53d681c9399f766b0cfff54e0469d04419b36fc1603e6db03e69cc8ad55f34.QueryAiAssistantApiResponse" }, "examples":{ "Successful response with context":{ "summary":"Successful response with context", "description":"Successful response with context", "value":{ "response":"Based on the documentation, you can send an SMS by using our SMS API. First, you need to authenticate using your API key, then make a POST request to the /sms/2/text/advanced endpoint with your message details.", "context":{ "originalContexts":[ { "text":"To send SMS messages, you need to use the SMS API endpoint...", "filename":"sms-api-guide.pdf" }, { "text":"Authentication is required for all API calls...", "filename":"authentication-guide.pdf" } ], "rerankedContexts":[ { "text":"To send SMS messages, you need to use the SMS API endpoint...", "filename":"sms-api-guide.pdf" } ] } } } } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "errorCode":"E400", "description":"Request cannot be processed.", "action":"Check the syntax, violations and adjust the request.", "violations":[ { "property":"property.path", "violation":"Violation message." } ], "resources":[] } } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "description":"Assistant not found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Assistant not found error":{ "summary":"Assistant not found error", "description":"Assistant not found error", "value":{ "errorCode":"40401", "description":"Assistant not found.", "action":"Check the description for error details.", "violations":[], "resources":[] } } } } } }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "ai:read" ], "x-is-early-access":true, "x-throttling-info":[ { "type":"time", "numberOfRequests":100, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/ai/1/aiassistants/{assistantId}/retrieve-context":{ "post":{ "tags":[ "ai-hub", "ai-assistants" ], "summary":"Retrieve Context from AI Assistant", "description":"Retrieves the most relevant context chunks from an AI assistant's knowledge base for a given message.
This endpoint performs a semantic search over the assistant's indexed documents and returns the most relevant text segments (top k chunks). You can specify how many chunks to return and optionally enable re-ranking for more accurate results.
The \"use shared history\" feature allowing an AI assistant to utilize the agent's conversation history, is only available if used together with [Infobip AI agents](https://www.infobip.com/docs/ai-agents).", "operationId":"retrieve-ai-assistant-context", "parameters":[ { "name":"assistantId", "in":"path", "description":"Unique identifier of the AI assistant from which to retrieve context.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"1ad5a87f-a6cd-3cc0-58c5-317db01440fd" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/2a53d681c9399f766b0cfff54e0469d04419b36fc1603e6db03e69cc8ad55f34.RetrieveContextRequest" } } }, "required":true }, "responses":{ "200":{ "description":"Context retrieved successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/2a53d681c9399f766b0cfff54e0469d04419b36fc1603e6db03e69cc8ad55f34.RetrieveContextApiResponse" }, "examples":{ "Successful context retrieval":{ "summary":"Successful context retrieval", "description":"Successful context retrieval", "value":{ "contexts":[ { "node":{ "id":"node-123-abc", "text":"To send SMS messages, you need to use the SMS API endpoint. Make a POST request to /sms/2/text/advanced with your authentication credentials and message payload.", "metadata":{ "source":"sms-api-guide.pdf", "page":5, "chapter":"Sending Messages" }, "startCharIdx":0, "endCharIdx":150 }, "score":0.92 }, { "node":{ "id":"node-456-def", "text":"Authentication is required for all API calls. You can authenticate using an API key in the Authorization header with the format 'App YOUR_API_KEY'.", "metadata":{ "source":"authentication-guide.pdf", "page":2 }, "startCharIdx":200, "endCharIdx":350 }, "score":0.85 } ] } } } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "errorCode":"E400", "description":"Request cannot be processed.", "action":"Check the syntax, violations and adjust the request.", "violations":[ { "property":"property.path", "violation":"Violation message." } ], "resources":[] } } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "description":"Assistant not found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Assistant not found error":{ "summary":"Assistant not found error", "description":"Assistant not found error", "value":{ "errorCode":"40401", "description":"Assistant not found.", "action":"Check the description for error details.", "violations":[], "resources":[] } } } } } }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "ai:read" ], "x-is-early-access":true, "x-throttling-info":[ { "type":"time", "numberOfRequests":100, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/sms/3/messages":{ "post":{ "tags":[ "channels", "sms", "outbound-sms", "send-message" ], "summary":"Send SMS message", "description":"With this API method, you can do anything from sending a basic message to one person, all the way to sending customized messages to thousands of recipients in one go. It comes with a range of useful features like transliteration, scheduling, and tracking in a unified way.\\\nIf utilizing Message Delivery Reports webhook, please consult the documentation provided at [Receive outbound SMS message reports](#channels/sms/receive-outbound-sms-message-report-v3).\\\nThis endpoint is the successor of [Send SMS message](#channels/sms/send-sms-message) and [Send binary SMS message](#channels/sms/send-binary-sms-message).", "externalDocs":{ "description":"Learn more about the SMS channel and its use cases", "url":"https://www.infobip.com/docs/sms" }, "operationId":"send-sms-messages", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsRequestEnvelope" }, "examples":{ "Send basic textual message":{ "summary":"Send basic textual message", "value":{ "messages":[ { "sender":"InfoSMS", "destinations":[ { "to":"41793026727" } ], "content":{ "text":"This is a sample message" } } ] } }, "Send fully-featured textual message":{ "summary":"Send fully-featured textual message", "value":{ "messages":[ { "sender":"InfoSMS", "destinations":[ { "to":"41793026727", "messageId":"MESSAGE-ID-123-xyz" }, { "to":"41793026834" } ], "content":{ "text":"Artık Ulusal Dil Tanımlayıcısı ile Türkçe karakterli smslerinizi rahatlıkla iletebilirsiniz.", "transliteration":"TURKISH", "language":{ "languageCode":"TR" } }, "options":{ "validityPeriod":{ "amount":720, "timeUnit":"HOURS" }, "campaignReferenceId":"summersale" }, "webhooks":{ "delivery":{ "url":"https://www.example.com/sms/advanced", "intermediateReport":true }, "contentType":"application/json", "callbackData":"DLR callback data" } }, { "sender":"41793026700", "destinations":[ { "to":"41793026700" } ], "content":{ "text":"A long time ago, in a galaxy far, far away... It is a period of civil war. Rebel spaceships, striking from a hidden base, have won their first victory against the evil Galactic Empire." }, "options":{ "deliveryTimeWindow":{ "days":[ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ], "from":{ "hour":6, "minute":0 }, "to":{ "hour":15, "minute":30 } } } } ], "options":{ "schedule":{ "bulkId":"BULK-ID-123-xyz", "sendAt":"2021-08-24T15:00:00.000+0000" }, "tracking":{ "shortenUrl":true, "trackClicks":true, "trackingUrl":"https://example.com/click-report", "removeProtocol":true, "customDomain":"example.com" }, "includeSmsCountInResponse":true, "conversionTracking":{ "useConversionTracking":true, "conversionTrackingName":"MY_CAMPAIGN" } } } }, "Send flash textual message":{ "summary":"Send flash textual message", "description":"Send a message that will pop-up on the user's phone", "value":{ "messages":[ { "sender":"InfoSMS", "destinations":[ { "to":"41793026727" } ], "content":{ "text":"Toto, I've got a feeling we're not in Kansas anymore." }, "options":{ "flash":true } } ] } }, "SMS language":{ "summary":"SMS language", "description":"Crossing SMS language barriers with the National Language Identifier for Turkish, Spanish and Portuguese", "value":{ "messages":[ { "sender":"InfoSMS", "destinations":[ { "to":"41793026727" } ], "content":{ "text":"Artık Ulusal Dil Tanımlayıcısı ile Türkçe karakterli smslerinizi rahatlıkla iletebilirsiniz.", "language":{ "languageCode":"TR" } } } ] } }, "SMS transliteration":{ "summary":"SMS transliteration", "description":"Send full-size messages in original language alphabet using transliteration conversion", "value":{ "messages":[ { "sender":"InfoSMS", "destinations":[ { "to":"41793026727" } ], "content":{ "text":"Ως Μεγαρικό ψήφισμα είνα…ι καθολικό εμπάργκο στα", "transliteration":"GREEK" } } ] } }, "Platform features":{ "summary":"Platform features", "description":"Parts of the SMS message, such as message sender, will be customized in accordance with provided application and entity ids. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "value":{ "messages":[ { "destinations":[ { "to":"41793026727" } ], "content":{ "text":"Custom application and entity based rules will be applied to this message" }, "options":{ "platform":{ "entityId":"promotional-traffic-entity", "applicationId":"marketing-automation-application" } } } ] } }, "Send Basic India DLT message":{ "summary":"Send Basic India DLT message", "description":"Send a message with India DLT parameters included", "value":{ "messages":[ { "sender":"InfoSMS", "destinations":[ { "to":"41793026727" } ], "content":{ "text":"India DLT parameters will be applied in this message" }, "options":{ "regional":{ "indiaDlt":{ "contentTemplateId":"1111111111111111111", "principalEntityId":"1111111111111111112", "telemarketerId":"111111111111" } } } } ] } }, "Send fully-featured binary SMS message":{ "summary":"Send fully-featured binary SMS message", "value":{ "messages":[ { "sender":"InfoSMS", "destinations":[ { "to":"41793026727", "messageId":"MESSAGE-ID-123-xyz" }, { "to":"41793026834" } ], "content":{ "dataCoding":0, "esmClass":0, "hex":"54 65 73 74 20 6d 65 73 73 61 67 65 2e" }, "options":{ "validityPeriod":{ "amount":720, "timeUnit":"HOURS" } }, "webhooks":{ "delivery":{ "url":"https://www.example.com/sms/advanced", "intermediateReport":true }, "contentType":"application/json", "callbackData":"DLR callback data" } }, { "sender":"41793026700", "destinations":[ { "to":"41793026700" } ], "content":{ "dataCoding":0, "esmClass":0, "hex":"41 20 6C 6F 6E 67 20 74 …20 45 6D 70 69 72 65 2E" }, "options":{ "deliveryTimeWindow":{ "days":[ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ], "from":{ "hour":6, "minute":0 }, "to":{ "hour":15, "minute":30 } }, "campaignReferenceId":"summersale" } } ], "options":{ "schedule":{ "bulkId":"BULK-ID-123-xyz", "sendAt":"2021-08-23T14:00:00.000+0000" } } } }, "Send Unicode flash binary SMS message":{ "summary":"Send Unicode flash binary SMS message", "value":{ "messages":[ { "sender":"InfoSMS", "destinations":[ { "to":"41793026727" } ], "content":{ "dataCoding":8, "esmClass":0, "hex":"0048 0065 006c 006c 006f 0020 0077 006f 0072 006c 0064 002c 0020 039a 03b1 03bb 03b7 03bc 03ad 03c1 03b1 0020 03ba 03cc 03c3 03bc 03b5 002c 0020 30b3 30f3 30cb 30c1 30cf" }, "options":{ "flash":true } } ] } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsRequestEnvelope" }, "examples":{ "Send basic textual message":{ "summary":"Send basic textual message", "value":"
\n 1 \n
\n \n 1 \n
\n \n 1 \n
\n **Note:** Make sure that special characters are properly encoded. Use a [URL encoding reference](https://www.w3schools.com/tags/ref_urlencode.asp) as a guide. This endpoint is the successor of [Send SMS message over query parameters](#channels/sms/send-sms-message-over-query-parameters).", "externalDocs":{ "description":"Learn more about SMS channel and use cases", "url":"https://www.infobip.com/docs/sms" }, "operationId":"send-sms-messages-over-query-parameters", "parameters":[ { "name":"bulkId", "in":"query", "description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "maxLength":100, "minLength":0 } }, { "name":"from", "in":"query", "description":"The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"InfoSMS" }, { "name":"to", "in":"query", "description":"List of message recipients.", "required":true, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string" } }, "example":"41793026727,41793026834" }, { "name":"text", "in":"query", "description":"Content of the message being sent.", "required":true, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"Message text" }, { "name":"flash", "in":"query", "description":"Sends a [flash SMS](https://www.infobip.com/docs/sms/message-types#flash-sms) if set to true.", "required":false, "style":"form", "explode":true, "schema":{ "type":"boolean" }, "example":true }, { "name":"transliteration", "in":"query", "description":"Conversion of a message text from one script to another.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"TURKISH" }, { "name":"languageCode", "in":"query", "description":"Code for language character set of a message content.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"TR" }, { "name":"intermediateReport", "in":"query", "description":"Use a [real-time intermediate delivery report](#channels/sms/receive-outbound-sms-message-report-v3) that will be sent on your callback server.", "required":false, "style":"form", "explode":true, "schema":{ "type":"boolean" }, "example":true }, { "name":"notifyUrl", "in":"query", "description":"The URL on your call back server on to which a delivery report will be sent.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"https://www.example.com" }, { "name":"notifyContentType", "in":"query", "description":"Preferred delivery report content type, `application/json` or `application/xml`.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"application/json" }, { "name":"callbackData", "in":"query", "description":"Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message [Delivery Report](#channels/sms/get-outbound-sms-message-delivery-reports-v3). The maximum value is 4000 characters.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "maxLength":4000, "minLength":0 }, "example":"callbackData" }, { "name":"validityPeriod", "in":"query", "description":"The message validity period in minutes. When the period expires, it will not be allowed for the message to be sent. Validity period longer than 48h is not supported. Any bigger value will automatically default back to `2880`.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32" }, "example":720 }, { "name":"sendAt", "in":"query", "description":"Date and time when the message is to be sent. Used for [scheduled SMS](#channels/sms/get-scheduled-sms-messages). Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. Must be sooner than 180 days from now.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "format":"date-time" } }, { "name":"includeSmsCountInResponse", "in":"query", "description":"Set to true to return smsCount in the response. Default is false. smsCount is the total count of SMS submitted in the request. SMS messages have a character limit and messages longer than that limit will be split into multiple SMS and reflected in the total count of SMS submitted. ", "required":false, "style":"form", "explode":true, "schema":{ "type":"boolean" } }, { "name":"trackingUrl", "in":"query", "description":"The URL of your callback server on to which the Click report will be sent.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"trackingType", "in":"query", "description":"Sets a custom conversion type naming convention, e.g. ONE_TIME_PIN, SOCIAL_INVITES, etc.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"Custom tracking type" }, { "name":"indiaDltContentTemplateId", "in":"query", "description":"The ID of your registered DLT (Distributed Ledger Technology) content template.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"1111111111111111111" }, { "name":"indiaDltPrincipalEntityId", "in":"query", "description":"Your DLT (Distributed Ledger Technology) entity id.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"1111111111111111112" }, { "name":"indiaDltTelemarketerId", "in":"query", "description":"Your assigned Telemarketer ID. (required for Aggregators)", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":111111111111 }, { "name":"turkeyIysBrandCode", "in":"query", "description":"Brand code is an ID of the company based on a company VAT number. If not provided in request, default value is used from your Infobip account.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32" } }, { "name":"turkeyIysRecipientType", "in":"query", "description":"Recipient Type must be TACIR or BIREYSEL", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"southKoreaResellerCode", "in":"query", "description":"Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32" } }, { "name":"southKoreaTitle", "in":"query", "description":"Title of the message.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "description":"Title of the message.", "maxLength":66, "minLength":0 } } ], "responses":{ "200":{ "description":"Successful response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsResponseEnvelope" }, "examples":{ "Response for request with one destination":{ "summary":"Response for request with one destination", "value":{ "bulkId":"2034072219640523072", "messages":[ { "messageId":"2250be2d4219-3af1-78856-aabe-1362af1edfd2", "status":{ "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED", "description":"Message sent to next instance" }, "destination":"41793026727", "details":{ "messageCount":1 } } ] } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsResponseEnvelope" }, "examples":{ "Response for request with one destination":{ "summary":"Response for request with one destination", "value":"
\n 1 \n
\n **Note:** Make sure that special characters and user credentials are properly encoded. Use a [URL encoding reference](https://www.w3schools.com/tags/ref_urlencode.asp) as a guide.", "externalDocs":{ "description":"Learn more about SMS channel and use cases", "url":"https://www.infobip.com/docs/sms" }, "operationId":"send-sms-message-over-query-parameters", "parameters":[ { "name":"username", "in":"query", "description":"Username for authentication.", "required":true, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"password", "in":"query", "description":"Password for authentication.", "required":true, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"bulkId", "in":"query", "description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. Anything above 100 characters passed in the request will be clipped during processing and returned in response, reports and logs.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"from", "in":"query", "description":"The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"InfoSMS" }, { "name":"to", "in":"query", "description":"List of message recipients.", "required":true, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string" } }, "example":"41793026727,41793026834" }, { "name":"text", "in":"query", "description":"Content of the message being sent.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"Message text" }, { "name":"flash", "in":"query", "description":"Sends a [flash SMS](https://www.infobip.com/docs/sms/message-types#flash-sms) if set to true.", "required":false, "style":"form", "explode":true, "schema":{ "type":"boolean" }, "example":true }, { "name":"transliteration", "in":"query", "description":"Conversion of a message text from one script to another.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"TURKISH" }, { "name":"languageCode", "in":"query", "description":"Code for language character set of a message content.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"TR" }, { "name":"intermediateReport", "in":"query", "description":"Use a [real-time intermediate delivery report](#channels/sms/receive-outbound-sms-message-report) that will be sent on your callback server.", "required":false, "style":"form", "explode":true, "schema":{ "type":"boolean" }, "example":true }, { "name":"notifyUrl", "in":"query", "description":"The URL on your call back server on to which a delivery report will be sent.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"https://www.example.com" }, { "name":"notifyContentType", "in":"query", "description":"Preferred delivery report content type, `application/json` or `application/xml`.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"application/json" }, { "name":"callbackData", "in":"query", "description":"Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message [Delivery Report](#channels/sms/get-outbound-sms-message-delivery-reports). The maximum value is 4000 characters.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "maxLength":4000, "minLength":0 }, "example":"callbackData" }, { "name":"validityPeriod", "in":"query", "description":"The message validity period in minutes. When the period expires, it will not be allowed for the message to be sent. Validity period longer than 48h is not supported. Any bigger value will automatically default back to `2880`.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int64" }, "example":720 }, { "name":"sendAt", "in":"query", "description":"Date and time when the message is to be sent. Used for [scheduled SMS](#channels/sms/get-scheduled-sms-messages). Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. Must be sooner than 180 days from now.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "format":"date-time" } }, { "name":"track", "in":"query", "description":"Sets the conversion element to be tracked. Possible values: `SMS` and `URL`. For more details on SMS Conversion, see: [Track Conversion](https://www.infobip.com/docs/sms/api#track-conversion).", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"URL" }, { "name":"processKey", "in":"query", "description":"The process key which uniquely identifies conversion tracking.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"trackingType", "in":"query", "description":"Sets a custom conversion type naming convention, e.g. ONE_TIME_PIN, SOCIAL_INVITES, etc.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"Custom tracking type" }, { "name":"indiaDltContentTemplateId", "in":"query", "description":"The ID of your registered DLT (Distributed Ledger Technology) content template.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"1111111111111111111" }, { "name":"indiaDltPrincipalEntityId", "in":"query", "description":"Your DLT (Distributed Ledger Technology) entity id.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"1111111111111111112" }, { "name":"indiaDltTelemarketerId", "in":"query", "description":"Your assigned Telemarketer ID. (required for Aggregators)", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":111111111111 }, { "name":"turkeyIysBrandCode", "in":"query", "description":"Brand code is an ID of the company based on a company VAT number. If not provided in request, default value is used from your Infobip account.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32" } }, { "name":"turkeyIysRecipientType", "in":"query", "description":"Recipient Type must be TACIR or BIREYSEL", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"southKoreaResellerCode", "in":"query", "description":"Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32" } } ], "responses":{ "200":{ "description":"Successful response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/cb1ef9a380a46bb9d49281818dd22b206a7f89260670bd103daadd3abc4386a3.QuerySmsResponse" }, "examples":{ "Response for request with one destination":{ "summary":"Response for request with one destination", "value":{ "bulkId":"2034072219640523072", "messages":[ { "messageId":"2250be2d4219-3af1-78856-aabe-1362af1edfd2", "status":{ "description":"Message sent to next instance", "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ENROUTE" }, "to":"41793026727", "smsCount":1 } ] } }, "Response for request with multiple destinations":{ "summary":"Response for request with multiple destinations", "value":{ "bulkId":"2034072219640523073", "messages":[ { "messageId":"2033247207850523791", "status":{ "description":"Message sent to next instance", "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ENROUTE" }, "to":"41793026727", "smsCount":1 }, { "messageId":"2033247207850523792", "status":{ "description":"Message sent to next instance", "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ENROUTE" }, "to":"41793026834", "smsCount":1 } ] } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/cb1ef9a380a46bb9d49281818dd22b206a7f89260670bd103daadd3abc4386a3.QuerySmsResponse" }, "examples":{ "Response for request with one destination":{ "summary":"Response for request with one destination", "value":"
- Buy a number capable of receiving SMS traffic.
- Specify a forwarding endpoint for the number and optionally configure other inbound settings.
Html body
\nRich HTML message body.
\nExample with default placeholders: {{default_ph}}
\nExample with personalized placeholders: {{to_ph}}
",
"defaultPlaceholders":"{\"default_ph\":\"Default placeholder\"}"
}
}
]
}
},
"Email with tracking options with multiple destinations":{
"summary":"Email with tracking options with multiple destinations",
"value":{
"messages":[
{
"sender":"jenny.smith@company.com",
"destinations":[
{
"to":[
{
"destination":"john.smith@company.com"
}
],
"cc":[
{
"destination":"bob.smith@somecompany.com"
}
],
"bcc":[
{
"destination":"alice.doe@somecompany.com"
}
]
}
],
"content":{
"subject":"Test message",
"html":"Html body
\nRich HTML message body.
\nThis is link that will be shortened and tracked link
"
}
}
],
"options":{
"schedule":{},
"tracking":{},
"clientPriority":"STANDARD"
}
}
},
"Email with attachments":{
"summary":"Email with attachments",
"value":{
"messages":[
{
"sender":"jenny.smith@company.com",
"destinations":[
{
"to":[
{
"destination":"john.smith@company.com"
}
]
}
],
"content":{
"subject":"Test message",
"text":"Text",
"attachments":[
{
"type":"binary",
"content":"Q29udGVudA==",
"contentType":"image/png",
"fileName":"image.png"
},
{
"type":"uploadedReference",
"contentId":"B44419205B27012D82F3BAD7B7EB37BA157EB26DCA268BD7C62F235165E04EB55EA620E2BB59715F3442C43852922601D294"
}
]
}
}
]
}
},
"Email with template ID":{
"summary":"Email with template ID",
"value":{
"messages":[
{
"destinations":[
{
"to":[
{
"destination":"john.smith@company.com"
}
]
}
],
"content":{
"templateId":"100000000123456"
}
}
]
}
},
"Email with IP pool ID":{
"summary":"Email with IP pool ID",
"value":{
"messages":[
{
"destinations":[
{
"to":[
{
"destination":"john.smith@company.com"
}
]
}
],
"content":{
"subject":"Test message",
"text":"Test body"
},
"ips":{
"ipPoolId":"08A3A7608750CC6E6080325A6ADF45B6"
}
}
]
}
},
"Email with masked placeholders":{
"summary":"Email with masked placeholders",
"value":{
"messages":[
{
"sender":"jenny.smith@company.com",
"destinations":[
{
"to":[
{
"destination":"john.smith@company.com",
"placeholders":"{\"name\": \"JohnDoe\", \"email\": \"test@example.com\", \"phone\": \"41793026727\"}"
}
]
}
],
"content":{
"subject":"Masking sensitive placeholders , Hi {{name}}, {{email}} , {{phone}}",
"html":"Test body {{ph1}} {{ph2}}",
"defaultPlaceholders":"{\"ph1\": \"Default\", \"ph2\": \"HideWholePlaceholder\"}"
},
"placeholdersMasking":[
{
"name":"ph1",
"side":"L",
"maskChar":"=",
"visibleChars":3
},
{
"name":"ph2",
"maskChar":"#",
"skipChars":[
"W"
]
},
{
"name":"name",
"side":"R",
"maskChar":"+",
"visibleChars":2
},
{
"name":"email",
"side":"L",
"maskChar":"=",
"delimiter":"@",
"skipChars":[
"_"
]
},
{
"name":"phone",
"side":"L",
"maskChar":"+",
"skipChars":[
"-",
"(",
")"
]
}
]
}
]
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailResponse"
},
"examples":{
"Success response":{
"summary":"Success response",
"value":{
"bulkId":"a28dd97c-2222-4fcf-99f1-0b557ed381da",
"messages":[
{
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":7,
"name":"PENDING_ENROUTE",
"description":"Message sent to next instance"
},
"destination":"john.smith@company.com"
}
]
}
},
"Success response with multiple destinations":{
"summary":"Success response with multiple destinations",
"value":{
"bulkId":"a28dd97c-2222-4fcf-99f1-0b557ed381da",
"messages":[
{
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":7,
"name":"PENDING_ENROUTE",
"description":"Message sent to next instance"
},
"destination":"john.smith@company.com"
},
{
"messageId":"2211d97c-53432-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":7,
"name":"PENDING_ENROUTE",
"description":"Message sent to next instance"
},
"destination":"john.doe@company.com"
}
]
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"message:send",
"email:message:send",
"email:manage"
],
"x-is-early-access":true,
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":4000,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
],
"x-versions":[
{
"versionNumber":4,
"latest":true,
"operationId":"send-email-messages-api"
},
{
"versionNumber":3,
"latest":false,
"operationId":"send-fully-featured-email"
}
]
}
},
"/email/1/content":{
"post":{
"tags":[
"channels",
"email",
"email-message-sending"
],
"summary":"Upload binary content",
"description":"This method allows you to upload binary content that you can reference when sending Email messages.",
"operationId":"upload-binary-content",
"parameters":[
{
"name":"X-Content-Id",
"in":"header",
"description":"Content ID that uniquely identifies the binary content.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"image_1_jpg"
},
{
"name":"X-Media-Type",
"in":"header",
"description":"Content mime type. Should be populated by standard MIME types (IANA media types).",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string"
},
"example":"image/jpeg"
},
{
"name":"X-Validity-Period-Minutes",
"in":"header",
"description":"Validity period in minutes after which the content will be deleted.",
"required":false,
"style":"simple",
"explode":false,
"schema":{
"type":"string",
"maximum":10080,
"minimum":1440
},
"example":3000
}
],
"requestBody":{
"content":{
"application/octet-stream":{
"schema":{
"type":"string",
"format":"binary"
},
"examples":{
"cURL":{
"summary":"cURL",
"description":"cURL",
"value":"curl -L -X POST 'https://{baseUrl}/email/1/content' \\\n-H 'Authorization: {authorization}' \\\n-H 'Content-Type: application/octet-stream' \\\n-H 'Accept: application/json' \\\n-H 'X-Media-Type: image/jpeg' \\\n-H 'X-Content-Id: image_1_jpg' \\\n--data-binary \"@/path/to/image1.jpg\"\n"
},
"HTTP":{
"summary":"HTTP",
"description":"HTTP",
"value":"POST /email/1/content HTTP/1.1\nHost: {baseUrl}\nAuthorization: {authorization}\nContent-Type: application/octet-stream\nAccept: application/json\nX-Content-Id: image_1_jpg\nX-Media-Type: image/jpeg\n\n(data)"
}
}
}
}
},
"responses":{
"200":{
"description":"Successful Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.UploadBinaryResult"
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.ApiErrorResponse"
},
"examples":{
"Response example":{
"summary":"Response example",
"value":{
"bulkId":"",
"messages":[],
"errorMessage":"Required request header 'X-Content-Id' for method parameter type String is not present"
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"email:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":500,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/email/3/send":{
"post":{
"tags":[
"channels",
"email",
"email-message-sending"
],
"summary":"Send fully featured email",
"description":"Send an email or multiple emails to a recipient or multiple recipients with CC/BCC enabled.",
"operationId":"send-fully-featured-email",
"requestBody":{
"content":{
"multipart/form-data":{
"schema":{
"$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.SendRequestSchema"
},
"examples":{
"Send fully featured email using curl":{
"summary":"Send fully featured email using curl",
"description":"Send fully featured email using curl",
"value":"\ncurl --request POST 'https://{base_url}/email/3/send' \\\n--header 'Authorization: Basic {username:password}' \\\n--form 'from=\"Jane Smith Html body
Rich HTML message body.
\"' \\\n--form 'attachment=@\"/home/user/image.png\"' \\\n--form 'bulkId=\"customBulkId\"' \\\n--form 'intermediateReport=\"true\"' \\\n--form-string 'defaultPlaceholders={\"ph1\": \"Success\", \"ph2\": \"Example\"}' \\\n--form-string 'headers={\"List-Unsubscribe\": \"your unsubscribe link\", \"X-Custom-Header\": \"Header value\"}' \\\n--form 'notifyUrl=\"https://www.example.com/email/advanced\"' \\\n--form 'notifyContentType=\"application/json\"' \\\n--form 'trackClicks=\"true\"' \\\n--form 'trackOpens=\"false\"' \\\n--form 'trackingPixelPosition=\"TOP\"' \\\n--form 'callbackData=\"DLR callback data\"'\n--form 'ipPoolId=\"08A3A7608750CC6E6080325A6ADF45B6\"'\n" }, "Send fully featured with preserved recipients email using curl":{ "summary":"Send fully featured with preserved recipients email using curl", "description":"Send fully featured with preserved recipients email using curl", "value":"\ncurl --request POST 'https://{base_url}/email/3/send' \\\n--header 'Authorization: Basic {username:password}' \\\n--form 'from=\"Jane SmithHtml body
Rich HTML message body.
\"' \\\n--form 'attachment=@\"/home/user/image.png\"' \\\n--form 'bulkId=\"customBulkId\"' \\\n--form 'intermediateReport=\"true\"' \\\n--form-string 'defaultPlaceholders={\"ph1\": \"Success\", \"ph2\": \"Example\"}' \\\n--form-string 'headers={\"List-Unsubscribe\": \"your unsubscribe link\", \"X-Custom-Header\": \"Header value\"}' \\\n--form 'notifyUrl=\"https://www.example.com/email/advanced\"' \\\n--form 'notifyContentType=\"application/json\"' \\\n--form 'trackClicks=\"true\"' \\\n--form 'trackOpens=\"false\"' \\\n--form 'trackingPixelPosition=\"TOP\"' \\\n--form 'callbackData=\"DLR callback data\"'\n--form 'ipPoolId=\"08A3A7608750CC6E6080325A6ADF45B6\"'\n" }, "Send fully featured email using Java":{ "summary":"Send fully featured email using Java", "description":"Send fully featured email using Java", "value":"\nimport org.springframework.core.io.FileSystemResource;\nimport org.springframework.http.*;\nimport org.springframework.util.LinkedMultiValueMap;\nimport org.springframework.web.client.RestTemplate;\nimport java.io.File; \n \nvar body = new LinkedMultiValueMapHtml body
Rich HTML message body.
\");\nbody.add(\"attachment\", new FileSystemResource(new File(\"/home/user/file.zip\")));\nbody.add(\"bulkId\", \"customBulkId\");\nbody.add(\"intermediateReport\", \"true\");\nbody.add(\"defaultPlaceholders\", \"{\\\"ph1\\\": \\\"Success\\\", \\\"ph2\\\": \\\"Example\\\"}\");\nbody.add(\"headers\", \"{\\\"List-Unsubscribe\\\": \\\"your unsubscribe link\\\", \\\"X-Custom-Header\\\": \\\"Header value\\\"}\");\nbody.add(\"notifyUrl\", \"https://www.example.com/email/advanced\");\nbody.add(\"notifyContentType\", \"application/json\");\nbody.add(\"trackClicks\", \"true\");\nbody.add(\"trackOpens\", \"false\");\nbody.add(\"trackingPixelPosition\", \"TOP\");\nbody.add(\"callbackData\", \"DLR callback data\");\nbody.add(\"ipPoolId\", \"08A3A7608750CC6E6080325A6ADF45B6\");\nvar headers = new HttpHeaders();\nheaders.setContentType(MediaType.MULTIPART_FORM_DATA);\nheaders.add(\"Authorization\", \"Basic {username:password}\");\nvar entity = new HttpEntity<>(body, headers);\nvar restTemplate = new RestTemplate();\nrestTemplate.postForEntity(\"https://{base_url}/email/3/send\", entity, String.class);\n" }, "Send fully featured email - HTTP":{ "summary":"Send fully featured email - HTTP", "description":"Send fully featured email - HTTP", "value":"\nPOST /email/3/send HTTP/1.1\nHost: {base_url}\nAuthorization: Basic {username:password}\nContent-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW\n \n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"from\"\n \nJane SmithHtml body
Rich HTML message body.
\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"attachment\"; filename=\"file.zip\"\n \n(data)\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"bulkId\"\n \ncustomBulkId\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"intermediateReport\"\n \ntrue\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"defaultPlaceholders\"\n \n{\"ph1\": \"Success\", \"ph2\": \"Example\"}\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"headers\"\n \n{\"List-Unsubscribe\": \"your unsubscribe link\", \"X-CustomHeader\": \"Header\"}\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"notifyUrl\"\n \nhttps://www.example.com/email/advanced\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"notifyContentType\"\n \napplication/json\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"trackClicks\"\n\ntrue\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"trackOpens\"\n\nfalse\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"trackingPixelPosition\"\n\nTOP\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"callbackData\"\n \nDLR callback data\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"ipPoolId\"\n\n08A3A7608750CC6E6080325A6ADF45B6\n------WebKitFormBoundary7MA4YWxkTrZu0gW--\n" }, "Send fully featured email using PHP":{ "summary":"Send fully featured email using PHP", "description":"Send fully featured email using PHP", "value":"\nsetUrl('https://{base_url}/email/3/send');\n $request->setMethod(HTTP_Request2::METHOD_POST);\n $request->setConfig(array(\n 'follow_redirects' => TRUE\n ));\n $request->setHeader(array(\n 'Authorization' => 'Basic {username:password}',\n 'Content-Type' => 'multipart/form-data'\n ));\n \n $request->addPostParameter(array(\n 'from' => 'Jane SmithHtml body
Rich HTML message body.
',\n 'bulkId' => 'customBulkId',\n 'intermediateReport' => 'true',\n 'defaultPlaceholders' => '{\"ph1\": \"Success\", \"ph2\": \"Example\"}'\n 'headers' => '{\"List-Unsubscribe\": \"your unsubscribe link\", \"X-Custom-Header\": \"HeaderValue\"}'\n 'notifyUrl' => 'https://www.example.com/email/advanced',\n 'notifyContentType' => 'application/json',\n 'trackClicks' => 'true',\n 'trackOpens' => 'false',\n 'trackingPixelPosition' => 'TOP',\n 'callbackData' => 'DLR callback data',\n 'ipPoolId' => '08A3A7608750CC6E6080325A6ADF45B6'\n ));\n \n $request->addUpload('attachment', '/home/files/image.jpg', 'image.jpg', 'Html body
Rich HTML message body.
\");\nrequest.AddParameter(\"attachment\", \"@files/image1.jpg\");\nrequest.AddParameter(\"bulkId\", \"customBulkId\");\nrequest.AddParameter(\"intermediateReport\", \"true\");\nrequest.AddParameter(\"defaultPlaceholders\", \"{\"ph1\": \"Success\", \"ph2\": \"Example\"}\")\nrequest.AddParameter(\"headers\", \"{\"List-Unsubscribe\": \"your unsubscribe link\", \"X-Custom-Header\": \"Header value\"}\")\nrequest.AddParameter(\"notifyUrl\", \"https://www.example.com/email/advanced\");\nrequest.AddParameter(\"notifyContentType\", \"application/json\");\nrequest.AddParameter(\"trackClicks\", \"true\");\nrequest.AddParameter(\"trackOpens\", \"false\");\nrequest.AddParameter(\"trackingPixelPosition\", \"TOP\");\nrequest.AddParameter(\"callbackData\", \"DLR callback data\");\nrequest.AddParameter(\"ipPoolId\", \"08A3A7608750CC6E6080325A6ADF45B6\");\nIRestResponse response = client.Execute(request);\nConsole.WriteLine(response.Content);\n" }, "Send fully featured email using JavaScript":{ "summary":"Send fully featured email using JavaScript", "description":"Send fully featured email using JavaScript", "value":"\nconst data = new FormData();\ndata.append(\"from\", \"Jane SmithHtml body
Rich HTML message body.
\");\ndata.append(\"attachment\", \"@files/image1.jpg\");\ndata.append(\"bulkId\", \"customBulkId\");\ndata.append(\"intermediateReport\", \"true\");\ndata.append(\"defaultPlaceholders\", \"{\\\"ph1\\\": \\\"Success\\\", \\\"ph2\\\": \\\"Example\\\"}\")\ndata.append(\"headers\", \"{\\\"List-Unsubscribe\\\": \\\"your unsubscribe link\\\", \\\"X-Custom-Header\\\": \\\"Header value\\\"}\")\ndata.append(\"notifyUrl\", \"https://www.example.com/email/advanced\");\ndata.append(\"notifyContentType\", \"application/json\");\ndata.append(\"trackClicks\", \"true\");\ndata.append(\"trackOpens\", \"false\");\ndata.append(\"trackingPixelPosition\", \"TOP\");\ndata.append(\"callbackData\", \"DLR callback data\");\ndata.append(\"ipPoolId\", \"08A3A7608750CC6E6080325A6ADF45B6\");\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n if (this.readyState === 4) {\n console.log(this.responseText);\n }\n});\n\nxhr.open(\"POST\", \"https://{{baseUrl}}}}/email/3/send\");\nxhr.setRequestHeader(\"Authorization\", \"Basic {username:password}\");\nxhr.send(data);\n" }, "Send fully featured email using Python":{ "summary":"Send fully featured email using Python", "description":"Send fully featured email using Python", "value":"\nimport requests\nimport json\n \nurl = 'https://{base_url}/email/3/send'\nheaders = {'Authorization': 'Basic {username:password}'}\n \nfile = open('files/image1.jpg', 'rb')\nfiles = {'attachment': ('image1.jpg', file)}\n \ndata = {\n 'from': 'Jane SmithHtml body
Rich HTML message body.
',\n 'attachment': '@/files/image1.jpg',\n 'bulkId': 'customBulkId',\n 'intermediateReport': 'true',\n 'defaultPlaceholders': '{\"ph1\": \"Success\", \"ph2\": \"Example\"}',\n 'headers': '{\"List-Unsubscribe\": \"your unsubscribe link\", \"X-CustomHeader\": \"Header value\"}',\n 'notifyUrl': 'https://www.example.com/email/advanced',\n 'notifyContentType': 'application/json',\n 'trackClicks': true,\n 'trackOpens': false,\n 'trackingPixelPosition': 'TOP',\n 'callbackData': 'DLR callback data'\n 'ipPoolId': '08A3A7608750CC6E6080325A6ADF45B6'\n}\n\nresponse = requests.post(url, headers=headers, data=data, files=files)\nfile.close()\nprint(response.text)\n" } } } } }, "responses":{ "200":{ "description":"Successful Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.SendResponse" }, "examples":{ "Example for single message":{ "summary":"Example for single message", "description":"Example for single message", "value":{ "bulkId":"snxemd8u52v7v84iiu69", "messages":[ { "to":"john.smith@somecompany.com", "messageId":"jgzra46v9zi1ztvd62t5", "status":{ "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED", "description":"Message accepted, pending for delivery." } } ] } }, "Example for single message with custom ID":{ "summary":"Example for single message with custom ID", "description":"Example for single message with custom ID", "value":{ "bulkId":"customBulkId", "messages":[ { "to":"john.smith@somecompany.com", "messageId":"jgzra46v9zi1ztvd62t5", "status":{ "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED", "description":"Message accepted, pending for delivery." } } ] } }, "Example for multiple message":{ "summary":"Example for multiple message", "description":"Example for multiple message", "value":{ "bulkId":"4pk1xihiy4rln2f1g2se", "messages":[ { "to":"john.smith@somecompany.com", "messageId":"tu5k6tdo7df1bpgk7ggs", "status":{ "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED", "description":"Message accepted, pending for delivery." } }, { "to":"jane.doe@somecompany.com", "messageId":"e7zzb1v9yirml2se9zo4", "status":{ "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED", "description":"Message accepted, pending for delivery." } } ] } } } } } }, "400":{ "$ref":"#/components/responses/ApiException400" }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-additional-throttling-information":{ "Learn more about custom throttling limits":"https://www.infobip.com/docs/api" }, "x-scopes":[ "message:send", "email:message:send", "email:manage" ], "x-additionalInfo":{ "markdown":"### Related\n- [Send email via SMTP API](https://www.infobip.com/docs/email/smtp-specification)\n- [Setup sender domain](https://www.infobip.com/docs/email/get-started#manage-domain-settings-register-a-new-domain)\n- [Tracking Notifications](https://www.infobip.com/docs/email/send-email-over-api#tracking-notifications)\n" }, "x-throttling-info":[ { "type":"time", "numberOfRequests":4000, "numberOfTimeUnits":0, "timeUnit":"s" } ], "x-versions":[ { "versionNumber":4, "latest":true, "operationId":"send-email-messages-api" }, { "versionNumber":3, "latest":false, "operationId":"send-fully-featured-email" } ] } }, "/email/4/mime":{ "post":{ "tags":[ "channels", "email", "email-message-sending" ], "summary":"Send MIME email", "description":"Send an email where you can specify the content as MIME message.", "operationId":"send-mime-email", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.SendMimeRequestSchema" }, "examples":{ "Example request with mimeMessage as a base64-encoded MIME string containing HTML, text, and single To recipient.":{ "summary":"Send email with single recipient using MIME", "description":"Example request with mimeMessage as a base64-encoded MIME string containing HTML, text, and single To recipient.", "value":{ "messageId":"requestMessageId", "from":"jenny.smith@company.com", "destinations":[ "john.smith@company" ], "mimeMessage":"RGF0ZTogV2VkLCAxOCBKdW4gMjAyNSAxMjo0ODoyMyArMDIwMCAoQ0VTVCkNCkZyb206IGplbm55LnNtaXRoQGNvbXBhbnkuY29tDQpUbzogam9obi5zbWl0aEBjb21wYW55LmNvbQ0KTWVzc2FnZS1JRDogPG1lc3NhZ2VAaWQ+DQpTdWJqZWN0OiBUaGlzIGlzIHN1YmplY3QNCk1JTUUtVmVyc2lvbjogMS4wDQpDb250ZW50LVR5cGU6IG11bHRpcGFydC9taXhlZDsgDQoJYm91bmRhcnk9Ii0tLS09X1BhcnRfMF8xNDkzMzcyMS4xNzUwMjQzNzAzMTY0Ig0KWC1JQi1idWxrLWlkOiBkZWZhdWx0QnVsa0lkDQoNCi0tLS0tLT1fUGFydF8wXzE0OTMzNzIxLjE3NTAyNDM3MDMxNjQNCkNvbnRlbnQtVHlwZTogdGV4dC9wbGFpbjsgY2hhcnNldD11cy1hc2NpaQ0KQ29udGVudC1UcmFuc2Zlci1FbmNvZGluZzogN2JpdA0KDQpIZWxsbyB3b3JsZA0KLS0tLS0tPV9QYXJ0XzBfMTQ5MzM3MjEuMTc1MDI0MzcwMzE2NA0KQ29udGVudC1UeXBlOiB0ZXh0L2h0bWw7IGNoYXJzZXQ9dXMtYXNjaWkNCkNvbnRlbnQtVHJhbnNmZXItRW5jb2Rpbmc6IDdiaXQNCg0KPGRpdj5IZWxsbyB3b3JsZDwvZGl2Pg0KLS0tLS0tPV9QYXJ0XzBfMTQ5MzM3MjEuMTc1MDI0MzcwMzE2NC0tDQo=" } }, "Example request with mimeMessage as a base64-encoded MIME string containing HTML, text, and multiple To recipients.":{ "summary":"Send email with multiple recipients using MIME", "description":"Example request with mimeMessage as a base64-encoded MIME string containing HTML, text, and multiple To recipients.", "value":{ "messageId":"requestMessageId", "from":"jenny.smith@company.com", "destinations":[ "john.smith@company", "mike.smith@company" ], "mimeMessage":"RGF0ZTogV2VkLCAxOCBKdW4gMjAyNSAxMjo1MTo1NiArMDIwMCAoQ0VTVCkNCkZyb206IGplbm55LnNtaXRoQGNvbXBhbnkuY29tDQpUbzogam9obi5zbWl0aEBjb21wYW55LmNvbSwgbWlrZS5zbWl0aEBjb21wYW55LmNvbQ0KTWVzc2FnZS1JRDogPG1lc3NhZ2VAaWQ+DQpTdWJqZWN0OiBUaGlzIGlzIHN1YmplY3QNCk1JTUUtVmVyc2lvbjogMS4wDQpDb250ZW50LVR5cGU6IG11bHRpcGFydC9taXhlZDsgDQoJYm91bmRhcnk9Ii0tLS09X1BhcnRfMF85NDM3NDk5MDIuMTc1MDI0MzkxNjE1NyINClgtSUItYnVsay1pZDogZGVmYXVsdEJ1bGtJZA0KDQotLS0tLS09X1BhcnRfMF85NDM3NDk5MDIuMTc1MDI0MzkxNjE1Nw0KQ29udGVudC1UeXBlOiB0ZXh0L3BsYWluOyBjaGFyc2V0PXVzLWFzY2lpDQpDb250ZW50LVRyYW5zZmVyLUVuY29kaW5nOiA3Yml0DQoNCkhlbGxvIHdvcmxkDQotLS0tLS09X1BhcnRfMF85NDM3NDk5MDIuMTc1MDI0MzkxNjE1Nw0KQ29udGVudC1UeXBlOiB0ZXh0L2h0bWw7IGNoYXJzZXQ9dXMtYXNjaWkNCkNvbnRlbnQtVHJhbnNmZXItRW5jb2Rpbmc6IDdiaXQNCg0KPGRpdj5IZWxsbyB3b3JsZDwvZGl2Pg0KLS0tLS0tPV9QYXJ0XzBfOTQzNzQ5OTAyLjE3NTAyNDM5MTYxNTctLQ0K" } }, "Example request with mimeMessage as a base64-encoded MIME string containing HTML, text, attachments and To, Cc and Bcc recipients.":{ "summary":"Send email with multiple recipients using complex MIME", "description":"Example request with mimeMessage as a base64-encoded MIME string containing HTML, text, attachments and To, Cc and Bcc recipients.", "value":{ "messageId":"requestMessageId", "from":"jenny.smith@company.com", "destinations":[ "john.smith@company", "mike.smith@company", "jenny.smith@company" ], "mimeMessage":"RGF0ZTogV2VkLCAxOCBKdW4gMjAyNSAxMjo1NTozNiArMDIwMCAoQ0VTVCkKRnJvbTogamVubnkuc21pdGhAY29tcGFueS5jb20KVG86IGpvaG4uc21pdGhAY29tcGFueS5jb20KQ2M6IG1pa2Uuc21pdGhAY29tcGFueS5jb20KQmNjOiBqZW5ueS5zbWl0aEBjb21wYW55Ck1lc3NhZ2UtSUQ6IDxtZXNzYWdlQGlkPgpTdWJqZWN0OiBUaGlzIGlzIHN1YmplY3QKTUlNRS1WZXJzaW9uOiAxLjAKQ29udGVudC1UeXBlOiBtdWx0aXBhcnQvbWl4ZWQ7CiBib3VuZGFyeT0iLS0tLT1fUGFydF8wXzY1OTQ5NDU5OS4xNzUwMjQ0MTM1OTg0IgpYLUlCLWJ1bGstaWQ6IGRlZmF1bHRCdWxrSWQKCi0tLS0tLT1fUGFydF8wXzY1OTQ5NDU5OS4xNzUwMjQ0MTM1OTg0CkNvbnRlbnQtVHlwZTogdGV4dC9wbGFpbjsgY2hhcnNldD11cy1hc2NpaQpDb250ZW50LVRyYW5zZmVyLUVuY29kaW5nOiA3Yml0CgpIZWxsbyB3b3JsZAoKLS0tLS0tPV9QYXJ0XzBfNjU5NDk0NTk5LjE3NTAyNDQxMzU5ODQKQ29udGVudC1UeXBlOiB0ZXh0L2h0bWw7IGNoYXJzZXQ9dXMtYXNjaWkKQ29udGVudC1UcmFuc2Zlci1FbmNvZGluZzogN2JpdAoKPGRpdj5IZWxsbyB3b3JsZCA8aW1nIHNyYz0iY2lkOmltYWdlXzEiLz4gPC9kaXY+CgotLS0tLS09X1BhcnRfMF82NTk0OTQ1OTkuMTc1MDI0NDEzNTk4NApDb250ZW50LVR5cGU6IHRleHQvcGxhaW47IGNoYXJzZXQ9dXMtYXNjaWk7IG5hbWU9YXR0YWNobWVudF8xCkNvbnRlbnQtVHJhbnNmZXItRW5jb2Rpbmc6IGJhc2U2NApDb250ZW50LURpc3Bvc2l0aW9uOiBhdHRhY2htZW50OyBmaWxlbmFtZT1hdHRhY2htZW50XzEKClZHaHBjeUJwY3lCaGRIUmhZMmh0Wlc1MElHUmhkR0U9CgoKLS0tLS0tPV9QYXJ0XzBfNjU5NDk0NTk5LjE3NTAyNDQxMzU5ODQKQ29udGVudC1UeXBlOiBpbWFnZS9qcGVnCkNvbnRlbnQtVHJhbnNmZXItRW5jb2Rpbmc6IGJhc2U2NApDb250ZW50LUlEOiBpbWFnZV8xCgpWR2hwY3lCcGN5QmhkSFJoWTJodFpXNTBJR1JoZEdFPQoKLS0tLS0tPV9QYXJ0XzBfNjU5NDk0NTk5LjE3NTAyNDQxMzU5ODQtLQ==" } } } } } }, "responses":{ "200":{ "description":"Successful Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.SendResponse" }, "examples":{ "Example for single message":{ "summary":"Example for single message", "description":"Example for single message", "value":{ "bulkId":"snxemd8u52v7v84iiu69", "messages":[ { "to":"john.smith@somecompany.com", "messageId":"jgzra46v9zi1ztvd62t5", "status":{ "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED", "description":"Message accepted, pending for delivery." } } ] } }, "Example for single message with custom ID":{ "summary":"Example for single message with custom ID", "description":"Example for single message with custom ID", "value":{ "bulkId":"customBulkId", "messages":[ { "to":"john.smith@somecompany.com", "messageId":"jgzra46v9zi1ztvd62t5", "status":{ "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED", "description":"Message accepted, pending for delivery." } } ] } }, "Example for multiple message":{ "summary":"Example for multiple message", "description":"Example for multiple message", "value":{ "bulkId":"4pk1xihiy4rln2f1g2se", "messages":[ { "to":"john.smith@somecompany.com", "messageId":"tu5k6tdo7df1bpgk7ggs", "status":{ "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED", "description":"Message accepted, pending for delivery." } }, { "to":"jane.doe@somecompany.com", "messageId":"e7zzb1v9yirml2se9zo4", "status":{ "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED", "description":"Message accepted, pending for delivery." } } ] } } } } } }, "400":{ "$ref":"#/components/responses/ApiException400" }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-additional-throttling-information":{ "Learn more about custom throttling limits":"https://www.infobip.com/docs/api" }, "x-scopes":[ "message:send", "email:message:send", "email:manage" ], "x-additionalInfo":{ "markdown":"### Related\n- [Send email via SMTP API](https://www.infobip.com/docs/email/smtp-specification)\n- [Setup sender domain](https://www.infobip.com/docs/email/get-started#manage-domain-settings-register-a-new-domain)\n- [Tracking Notifications](https://www.infobip.com/docs/email/send-email-over-api#tracking-notifications)\n" }, "x-throttling-info":[ { "type":"time", "numberOfRequests":4000, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/email/1/bulks":{ "get":{ "tags":[ "channels", "email", "scheduled-email" ], "summary":"Get scheduled bulks", "description":"See the scheduled time of your Email messages.", "operationId":"get-scheduled-emails", "parameters":[ { "name":"bulkId", "in":"query", "description":"The ID that uniquely identifies the sent bulk.", "required":true, "style":"form", "explode":true, "schema":{ "type":"string", "description":"The ID that uniquely identifies the sent bulk." }, "example":{ "sendAt":"2025-12-01T15:00:00.000Z" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkScheduleResponse" }, "examples":{ "Get sent email bulks response - single bulk":{ "summary":"Get sent email bulks response - single bulk", "description":"Get sent email bulks response - single bulk", "value":{ "externalBulkId":"BULK-ID-123-xyz", "bulks":[ { "bulkId":"2033247207450906897", "sendAt":"2025-12-01T12:00:00.000+0000" } ] } }, "Get sent email bulks response - multiple bulks":{ "summary":"Get sent email bulks response - multiple bulks", "description":"Get sent email bulks response - multiple bulks", "value":{ "externalBulkId":"BULK-ID-123-xyz", "bulks":[ { "bulkId":"2033247207450906897", "sendAt":"2025-12-01T12:00:00.000+0000" }, { "bulkId":"2033247207450906898", "sendAt":"2025-12-01T14:00:00.000+0000" }, { "bulkId":"2033247207450906899", "sendAt":"2025-12-01T16:00:00.000+0000" } ] } } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Bulk not found" } } } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "email:manage", "email:message:send" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":100, "numberOfTimeUnits":0, "timeUnit":"m" } ] }, "put":{ "tags":[ "channels", "email", "scheduled-email" ], "summary":"Reschedule messages", "description":"Change the date and time for sending scheduled messages.", "operationId":"reschedule-emails", "parameters":[ { "name":"bulkId", "in":"query", "description":"The ID that uniquely identifies the sent bulk.", "required":true, "style":"form", "explode":true, "schema":{ "type":"string", "description":"The ID that uniquely identifies the sent bulk." }, "example":"BULK-ID-123-xyz" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkRescheduleRequest" }, "examples":{ "Reschedule email bulk request":{ "summary":"Reschedule email bulk request", "description":"Reschedule email bulk request", "value":{ "sendAt":"2025-12-01T15:00:00.000Z" } } } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkRescheduleResponse" }, "examples":{ "Reschedule email bulk response":{ "summary":"Reschedule email bulk response", "description":"Reschedule email bulk response", "value":{ "bulkId":"2033247207450906897", "sendAt":"2025-12-01T15:00:00.000+0000" } } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Bulk not found" } } } } } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "requestError":{ "serviceException":{ "messageId":"CONFLICT", "text":"Update not allowed for bulk" } } } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "email:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":100, "numberOfTimeUnits":0, "timeUnit":"m" } ] } }, "/email/1/bulks/status":{ "get":{ "tags":[ "channels", "email", "scheduled-email" ], "summary":"Get scheduled bulk statuses", "description":"See the status of scheduled email messages.", "operationId":"get-scheduled-email-statuses", "parameters":[ { "name":"bulkId", "in":"query", "description":"The ID that uniquely identifies the sent bulk.", "required":true, "style":"form", "explode":true, "schema":{ "type":"string", "description":"The ID that uniquely identifies the sent bulk." }, "example":"BULK-ID-123-xyz" } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkStatusResponse" }, "examples":{ "Get bulk status response - paused":{ "summary":"Get bulk status response - paused", "description":"Get bulk status response - paused", "value":{ "externalBulkId":"BULK-ID-123-xyz", "bulks":[ { "bulkId":"2033247207450906897", "status":"PAUSED" } ] } }, "Get bulk status response - canceled":{ "summary":"Get bulk status response - canceled", "description":"Get bulk status response - canceled", "value":{ "externalBulkId":"BULK-ID-123-xyz", "bulks":[ { "bulkId":"2033247207450906897", "status":"CANCELED" } ] } } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Bulk not found" } } } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "email:manage", "email:message:send" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":100, "numberOfTimeUnits":0, "timeUnit":"m" } ] }, "put":{ "tags":[ "channels", "email", "scheduled-email" ], "summary":"Update scheduled message statuses", "description":"Change status or completely cancel sending of scheduled messages.", "operationId":"update-scheduled-email-statuses", "parameters":[ { "name":"bulkId", "in":"query", "description":"The ID that uniquely identifies the sent bulk.", "required":true, "style":"form", "explode":true, "schema":{ "type":"string", "description":"The ID that uniquely identifies the sent bulk." }, "example":"BULK-ID-123-xyz" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkUpdateStatusRequest" }, "examples":{ "Update bulk status request - pause":{ "summary":"Update bulk status request - pause", "description":"Update bulk status request - pause", "value":{ "status":"PAUSED" } }, "Update bulk status request - cancel":{ "summary":"Update bulk status request - cancel", "description":"Update bulk status request - cancel", "value":{ "status":"CANCELED" } } } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkUpdateStatusResponse" }, "examples":{ "Update bulk status response - paused":{ "summary":"Update bulk status response - paused", "description":"Update bulk status response - paused", "value":{ "bulkId":"BULK-ID-123-xyz", "status":"PAUSED" } }, "Update bulk status response - canceled":{ "summary":"Update bulk status response - canceled", "description":"Update bulk status response - canceled", "value":{ "bulkId":"BULK-ID-123-xyz", "status":"CANCELED" } } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Bulk not found" } } } } } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "requestError":{ "serviceException":{ "messageId":"CONFLICT", "text":"Update not allowed for bulk" } } } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "email:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":100, "numberOfTimeUnits":0, "timeUnit":"m" } ] } }, "/email/4/logs":{ "get":{ "tags":[ "channels", "email", "email-logs-and-reports" ], "summary":"Get email message logs", "description":"Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours.", "operationId":"get-email-message-logs", "parameters":[ { "name":"sender", "in":"query", "description":"The sender ID which can be alphanumeric or numeric.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"destination", "in":"query", "description":"Message destination address.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"bulkId", "in":"query", "description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters.", "required":false, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string" } }, "example":"BULK-ID-123-xyz" }, { "name":"messageId", "in":"query", "description":"Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters.", "required":false, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string" } }, "example":"MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz" }, { "name":"generalStatus", "in":"query", "required":false, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.MessageGeneralStatus" } }, { "name":"sentSince", "in":"query", "description":"The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "format":"date-time" }, "example":"2020-02-22T17:42:05.390+01:00" }, { "name":"sentUntil", "in":"query", "description":"The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "format":"date-time", "description":"The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.", "example":"2020-02-23T17:42:05.39+01:00" }, "example":"2020-02-23T17:42:05.390+01:00" }, { "name":"limit", "in":"query", "description":"Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":50, "maximum":1000 } }, { "name":"entityId", "in":"query", "description":"Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"promotional-traffic-entity" }, { "name":"applicationId", "in":"query", "description":"Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"marketing-automation-application" }, { "name":"campaignReferenceId", "in":"query", "description":"ID of a campaign that was sent in the message. May contain multiple comma-separated values.", "required":false, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string" } }, "example":"summersale" }, { "name":"useCursor", "in":"query", "description":"Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs.", "required":false, "style":"form", "explode":true, "schema":{ "type":"boolean" } }, { "name":"cursor", "in":"query", "description":"Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.LogResponseEmailUnificationLog" } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "email:manage", "email:logs:read" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":120, "numberOfTimeUnits":0, "timeUnit":"m" } ], "x-versions":[ { "versionNumber":4, "latest":true, "operationId":"get-email-message-logs" }, { "versionNumber":1, "latest":false, "operationId":"get-email-logs" } ] } }, "/email/4/reports":{ "get":{ "tags":[ "channels", "email", "email-logs-and-reports" ], "summary":"Get email delivery reports", "description":"Get one-time delivery reports for all sent emails.", "externalDocs":{ "description":"Learn more about EMAIL channel and use cases", "url":"https://www.infobip.com/docs/email" }, "operationId":"get-outbound-email-message-delivery-reports", "parameters":[ { "name":"bulkId", "in":"query", "description":"The ID that uniquely identifies the request.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"messageId", "in":"query", "description":"The ID that uniquely identifies the message sent.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"limit", "in":"query", "description":"Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":50, "maximum":1000 }, "example":1 }, { "name":"entityId", "in":"query", "description":"Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"promotional-traffic-entity" }, { "name":"applicationId", "in":"query", "description":"Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"marketing-automation-application" }, { "name":"campaignReferenceId", "in":"query", "description":"ID of a campaign that was sent in the message.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"summersale" } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailDeliveryReports" } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "message:send", "email:message:send", "email:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":120, "numberOfTimeUnits":0, "timeUnit":"m" } ], "x-versions":[ { "versionNumber":4, "latest":true, "operationId":"get-outbound-email-message-delivery-reports" }, { "versionNumber":1, "latest":false, "operationId":"get-email-delivery-reports" } ] } }, "/email/1/logs":{ "get":{ "tags":[ "channels", "email", "email-logs-and-reports" ], "summary":"Get email message logs", "description":"This method allows you to get logs for sent emails using their messageId. Email logs are available for the last 48 hours.", "operationId":"get-email-logs", "parameters":[ { "name":"messageId", "in":"query", "description":"The ID that uniquely identifies the sent email.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"from", "in":"query", "description":"From email address.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"to", "in":"query", "description":"The recipient email address.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"bulkId", "in":"query", "description":"Bulk ID that uniquely identifies the request.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"campaignReferenceId", "in":"query", "description":"The ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"generalStatus", "in":"query", "description":"Indicates whether the initiated email has been successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"sentSince", "in":"query", "description":"Tells when the email was initiated. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "format":"date-time", "example":"2021-01-02T01:00:00.123Z" } }, { "name":"sentUntil", "in":"query", "description":"Tells when the email request was processed by Infobip.Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "format":"date-time", "example":"2021-01-02T01:00:00.123Z" } }, { "name":"limit", "in":"query", "description":"Maximum number of logs.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "maximum":1000 } }, { "name":"applicationId", "in":"query", "description":"[Application](https://www.infobip.com/docs/cpaas-x/application-and-entity-management#application) identifier used for filtering.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"entityId", "in":"query", "description":"[Entity](https://www.infobip.com/docs/cpaas-x/application-and-entity-management#entity) identifier used for filtering.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailLogResponse" } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "email:logs:read", "email:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":60, "numberOfTimeUnits":0, "timeUnit":"m" } ], "x-versions":[ { "versionNumber":4, "latest":true, "operationId":"get-email-message-logs" }, { "versionNumber":1, "latest":false, "operationId":"get-email-logs" } ] } }, "/email/1/reports":{ "get":{ "tags":[ "channels", "email", "email-logs-and-reports" ], "summary":"Get email delivery reports", "description":"Get one-time delivery reports for all sent emails.", "operationId":"get-email-delivery-reports", "parameters":[ { "name":"bulkId", "in":"query", "description":"Bulk ID for which report is requested.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"messageId", "in":"query", "description":"The ID that uniquely identifies the sent email.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"campaignReferenceId", "in":"query", "description":"The ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"limit", "in":"query", "description":"Maximum number of reports.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "maximum":1000 } }, { "name":"applicationId", "in":"query", "description":"[Application](https://www.infobip.com/docs/cpaas-x/application-and-entity-management#application) identifier used for filtering.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"entityId", "in":"query", "description":"[Entity](https://www.infobip.com/docs/cpaas-x/application-and-entity-management#entity) identifier used for filtering.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.ApiReportsResponse" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "message:send", "email:message:send", "email:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":60, "numberOfTimeUnits":0, "timeUnit":"m" } ], "x-versions":[ { "versionNumber":4, "latest":true, "operationId":"get-outbound-email-message-delivery-reports" }, { "versionNumber":1, "latest":false, "operationId":"get-email-delivery-reports" } ] } }, "/email/2/validation":{ "post":{ "tags":[ "channels", "email", "email-validation" ], "summary":"Validate email address", "description":"This method lets you request validation of a single email address in real-time,\nhelping you to identify and remove poor-quality emails from your list.\n", "operationId":"validate-email-addresses", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ValidationRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "to":"john.smith@example.com" } } } }, "application/x-www-form-urlencoded":{ "schema":{ "$ref":"#/components/schemas/45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ValidationRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":"curl -s --user user:password https://{base_url}/email/2/validation --data-urlencode 'to=john.smith@example.com'" } } } } }, "responses":{ "200":{ "description":"Successful response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ValidationResponse" }, "examples":{ "Valid email box response":{ "summary":"Valid email box response", "description":"Valid email box response", "value":{ "to":"john.smith@example.com", "validMailbox":"true", "validSyntax":true, "catchAll":false, "disposable":false, "roleBased":false, "risk":"LOW" } }, "Invalid email box response":{ "summary":"Invalid email box response", "description":"Invalid email box response", "value":{ "to":"jane.smith@example.com", "validMailbox":"false", "validSyntax":true, "catchAll":false, "disposable":false, "roleBased":false, "detailedReasons":"known_hardbounce", "risk":"HIGH" } }, "Mailbox is unknown response":{ "summary":"Mailbox is unknown response", "description":"Mailbox is unknown response", "value":{ "to":"john.doe@example.org", "validMailbox":"unknown", "validSyntax":true, "catchAll":false, "disposable":false, "roleBased":false, "reason":"INBOX_FULL", "detailedReasons":"mailbox_full", "risk":"HIGH" } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ValidationResponse" }, "examples":{ "Valid email box response":{ "summary":"Valid email box response", "description":"Valid email box response", "value":"