Infobip Customer Engagement API

Complete solutions that will help you drive better outcomes for your customers and business across the entire customer journey.

Operations 254

Showing the first 250 of 254. The full set is in the contract, and via get_provider_operations.

GET /people/2/persons Get a single person or a list of people #
PUT /people/2/persons Update a person #
POST /people/2/persons Create a new person #
DELETE /people/2/persons Delete a person #
PATCH /people/2/persons Partial person update #
PUT /people/2/persons/contactInformation Set contact information to person #
DELETE /people/2/persons/contactInformation Delete contact information from person #
PATCH /people/2/persons/contactInformation Add contact information to person #
POST /people/2/persons/batch Batch people create #
DELETE /people/2/persons/batch Batch people delete #
PATCH /people/2/persons/batch Batch people update #
POST /people/2/persons/match Match profiles #
POST /people/3/persons/merge Batch merge profiles #
PUT /people/3/persons/upsert Batch full people upsert #
PATCH /people/3/persons/upsert Batch partial people upsert #
GET /people/2/companies Get a single company or a list of companies #
POST /people/2/companies Create a new company #
DELETE /people/2/companies Delete a company #
PATCH /people/2/companies Partial company update #
POST /people/2/companies/batch Batch companies create #
DELETE /people/2/companies/batch Batch companies delete #
PATCH /people/2/companies/batch Batch companies update #
DELETE /people/2/companies/persons Remove persons from company batch #
PATCH /people/2/companies/persons Add persons to company batch #
GET /people/2/tags Get list of tags #
POST /people/2/tags Create a new tag #
GET /people/2/tags/{name} Get a tag #
DELETE /people/2/tags/{name} Delete a tag #
DELETE /people/2/tags/{name}/persons Remove tag from people batch #
PATCH /people/2/tags/{name}/persons Add tag to people batch #
GET /people/2/customAttributes Get a list of custom attributes #
POST /people/2/customAttributes Create a custom attribute #
GET /people/2/customAttributes/{name} Get a single custom attribute #
DELETE /people/2/customAttributes/{name} Delete a custom attribute #
POST /people/2/customAttributes/{name}/append Append item to custom attribute #
GET /people/3/lists/{listName}/items Get items #
POST /people/3/lists/{listName}/items Append items #
DELETE /people/3/lists/{listName}/items Delete items #
PUT /people/3/lists/{listName}/items/{itemId} Replace an item #
PATCH /people/3/lists/{listName}/items/{itemId} Update an item #
GET /people/3/lists Get lists #
DELETE /people/3/lists Delete lists #
PUT /people/3/lists/{listName} Replace a list #
PATCH /people/3/lists/{listName} Update a list #
GET /people/2/persons/{personId}/lists/{listName}/items Get items #
POST /people/2/persons/{personId}/lists/{listName}/items Append items #
DELETE /people/2/persons/{personId}/lists/{listName}/items Delete items #
PUT /people/2/persons/{personId}/lists/{listName}/items/{itemId} Replace an item #
PATCH /people/2/persons/{personId}/lists/{listName}/items/{itemId} Update an item #
GET /people/2/persons/{personId}/lists Get lists #
DELETE /people/2/persons/{personId}/lists Delete lists #
PUT /people/2/persons/{personId}/lists/{listName} Replace a list #
PATCH /people/2/persons/{personId}/lists/{listName} Update a list #
GET /people/2/contactInformation/push/{pushRegId} Get push device registration #
PATCH /people/2/contactInformation/push/{pushRegId} Update push device registration #
POST /people/2/contactInformation/push/{pushRegId}/depersonalize Depersonalize push instance #
POST /people/2/contactInformation/push/{pushRegId}/personalize Personalize push instance #
POST /people/3/events Batch Send Events #
POST /peopleevents/2/persons/{personId}/definitions/{definitionId}/events Send Event #
GET /peopleevents/2/definitions List Event Definitions #
POST /peopleevents/2/definitions Create Event Definition #
GET /peopleevents/2/definitions/{definitionId} Get Event Definition #
POST /peopleevents/2/definitions/{definitionId} Update Event Definition #
POST /peopleevents/1/export Submit event export request #
GET /peopleevents/1/export/status/{requestId} Check status of event export request #
DELETE /peopleevents/1/export/{requestId} Asynchronous cancellation of an event export request #
GET /peopleevents/1/export/definitions Get list of event definitions #
GET /people/3/segments Get a list of segments #
POST /people/3/segments Create a segment #
GET /people/3/segments/{segmentId} Get a segment #
PUT /people/3/segments/{segmentId} Update a segment #
DELETE /people/3/segments/{segmentId} Delete a segment #
GET /people/3/segments/{segmentId}/persons Get persons in a segment #
POST /moments/1/flows/{campaignId}/participants Add participants to flow #
GET /moments/1/flows/{campaignId}/participants/report Get a report on participants added to flow #
POST /communication/1/flows/{campaignId}/participants Add Person to Flow #
DELETE /communication/1/flows/{campaignId}/participants Remove person from flow #
GET /forms/1/forms Get forms #
GET /forms/1/forms/{id} Get form #
POST /forms/1/forms/{id}/views Increment form view count #
POST /forms/1/forms/{id}/data Submit form data #
GET /ccaas/1/conversations Get conversations #
POST /ccaas/1/conversations Create conversation #
GET /ccaas/1/conversations/{conversationId} Get conversation #
PUT /ccaas/1/conversations/{conversationId} Update conversation #
PATCH /ccaas/1/conversations/{conversationId} Patch conversation #
POST /ccaas/1/conversations/{conversationId}/tags Add tag to conversation #
PUT /ccaas/1/conversations/{conversationId}/assignee Change conversation assignment #
DELETE /ccaas/1/conversations/{conversationId}/assignee Unassign conversation agent #
DELETE /ccaas/1/conversations/{conversationId}/tags/{tagName} Remove tag from conversation #
POST /ccaas/1/conversations/{conversationId}/route Route conversation #
GET /ccaas/1/conversations/{conversationId}/simulate-routing Simulate routing result for conversation #
GET /ccaas/1/conversations/{conversationId}/links Get linked conversations #
GET /ccaas/1/tags Get tags #
POST /ccaas/1/tags Create tag #
DELETE /ccaas/1/tags/{tagName} Delete tag #
GET /ccaas/1/conversations/{conversationId}/messages Get messages #
POST /ccaas/1/conversations/{conversationId}/messages Create message #
POST /ccaas/1/conversations/{conversationId}/events Send a conversation event #
GET /ccaas/1/conversations/{conversationId}/notes Get notes #
POST /ccaas/1/conversations/{conversationId}/notes Create note #
GET /ccaas/1/conversations/{conversationId}/notes/{noteId} Get note #
GET /ccaas/1/agents Get agents #
POST /ccaas/1/agents Create agent #
GET /ccaas/1/agents/{agentId} Get agent #
PUT /ccaas/1/agents/{agentId} Update agent #
GET /ccaas/1/agents/{agentId}/conversations Get agent conversations #
PUT /ccaas/1/agents/{agentId}/status Change agents status #
POST /ccaas/1/agents/{agentId}/queues Add agent to queue #
DELETE /ccaas/1/agents/{agentId}/queues/{queueId} Remove agent from queue #
PUT /ccaas/1/agents/{agentId}/heartbeat Set agents heartbeat #
GET /ccaas/1/queues Get queues #
POST /ccaas/1/queues Create queue #
PUT /ccaas/1/queues/{queueId} Update queue #
DELETE /ccaas/1/queues/{queueId} Delete queue #
GET /ccaas/1/routing Get routing #
PUT /ccaas/1/routing Create routing #
DELETE /ccaas/1/routing Delete routing #
GET /ccaas/1/bots Get Bots #
POST /ccaas/1/bots Create bot #
GET /ccaas/1/bots/{botId} Get bot #
PUT /ccaas/1/bots/{botId} Update bot #
DELETE /ccaas/1/bots/{botId} Delete bot #
GET /ccaas/1/conversations/{conversationId}/metadata Get metadata #
PUT /ccaas/1/conversations/{conversationId}/metadata Put metadata #
DELETE /ccaas/1/conversations/{conversationId}/metadata Delete metadata #
PATCH /ccaas/1/conversations/{conversationId}/metadata Patch metadata #
GET /ccaas/1/templates Get templates #
GET /ccaas/1/templates/{templateId} Get template #
GET /ccaas/2/conversation-forms/forms Get conversation forms #
POST /ccaas/2/conversation-forms/forms Create conversation form #
GET /ccaas/2/conversation-forms/forms/{id} Get conversation form #
PUT /ccaas/2/conversation-forms/forms/{id} Update conversation form #
DELETE /ccaas/2/conversation-forms/forms/{id} Delete conversation form #
GET /ccaas/2/conversation-forms/fields Get fields #
POST /ccaas/2/conversation-forms/fields Create field #
GET /ccaas/2/conversation-forms/fields/{id} Get field #
PUT /ccaas/2/conversation-forms/fields/{id} Update field #
DELETE /ccaas/2/conversation-forms/fields/{id} Delete field #
GET /ccaas/2/conversation-forms/triggers Get triggers #
POST /ccaas/2/conversation-forms/triggers Create trigger #
GET /ccaas/2/conversation-forms/triggers/{id} Get trigger #
PUT /ccaas/2/conversation-forms/triggers/{id} Update trigger #
DELETE /ccaas/2/conversation-forms/triggers/{id} Delete trigger #
PATCH /ccaas/2/conversation-forms/triggers/{id} Patch trigger #
GET /ccaas/2/conversations/{conversationId}/form Get dispositions #
PUT /ccaas/2/conversations/{conversationId}/form Update or insert dispositions #
DELETE /ccaas/2/conversations/{conversationId}/form/{id} Delete disposition #
POST /ccaas/2/conversations/{conversationId}/form/assign Assign form to conversation #
POST /ccaas/2/conversations/{conversationId}/form/unassign Un-assign form from conversation #
PUT /ccaas/1/account/configuration Update account configuration #
GET /ccca/1/agent-configs/{agentId} Get agent configuration #
POST /ccaas/voice/2/outbound-call-conversation Create outbound call conversation #
GET /ccaas/voice/2/waiting-strategies Get all waiting strategies #
POST /ccaas/voice/2/waiting-strategies Create waiting strategy #
GET /ccaas/voice/2/waiting-strategies/{id} Get waiting strategy #
PUT /ccaas/voice/2/waiting-strategies/{id} Update waiting strategy #
DELETE /ccaas/voice/2/waiting-strategies/{id} Delete waiting strategy #
GET /ccaas/voice/2/account-recording-config Get account recording configuration #
PUT /ccaas/voice/2/account-recording-config Update account recording configuration #
POST /ccaas/voice/2/account-recording-config Create account recording configuration #
GET /ccaas/voice/2/agent-recording-configs Get agent recording configurations #
GET /ccaas/voice/2/agent-recording-configs/{agentId} Get agent recording configuration #
PUT /ccaas/voice/2/agent-recording-configs/{agentId} Update agent recording configuration #
POST /ccaas/voice/2/agent-recording-configs/{agentId} Create agent recording configuration #
GET /ccaas/voice/2/recording/metadata Get recording metadata #
GET /ccaas/voice/2/recording/download/{recordingId} Download call recording #
GET /ccaas/voice/2/account-wrap-up-config Get account wrap up configuration #
PUT /ccaas/voice/2/account-wrap-up-config Update account wrap up configuration #
PUT /ccca/1/agent-configs/{agentId}/wrap-up Update agent wrap up configuration #
PATCH /ccaas/voice/2/agent/{agentId}/wrap-up-time/add/{seconds} Add agent wrap up time #
PATCH /ccaas/voice/2/agent/{agentId}/wrap-up-time/clear Clear agent wrap up time #
PATCH /ccaas/voice/2/conversation/{conversationId}/transfer/agent Transfer call to another agent #
GET /ccaas/voice/2/transfer/queues Fetch queues eligible as transfer destination #
PATCH /ccaas/voice/2/conversation/{conversationId}/transfer/queue Transfer call to another queue #
PATCH /ccaas/voice/2/conversation/{conversationId}/transfer/external-number Transfer call to external number #
GET /ccaas/voice/2/transfer-configs/external-number Get transfer to external number configuration #
PUT /ccaas/voice/2/transfer-configs/external-number Update transfer to external number configuration #
GET /ccaas/voice/2/transfer-configs/transfer-strategy Get transfer strategy #
PUT /ccaas/voice/2/transfer-configs/transfer-strategy Update transfer strategy #
PATCH /ccaas/voice/2/{conversationId}/hold Put client on hold #
PATCH /ccaas/voice/2/{conversationId}/unhold Put client off hold #
GET /ccaas/voice/2/hold-configs-per-queue Get hold configurations #
POST /ccaas/voice/2/hold-configs-per-queue Create hold configuration #
GET /ccaas/voice/2/hold-configs-per-queue/{id} Get hold configuration #
PUT /ccaas/voice/2/hold-configs-per-queue/{id} Update hold configuration #
DELETE /ccaas/voice/2/hold-configs-per-queue/{id} Delete hold configuration #
GET /ccaas/voice/2/call-timeouts Get call timeout #
PUT /ccaas/voice/2/call-timeouts Update call timeout #
DELETE /ccaas/voice/2/call-timeouts Remove custom call timeout #
GET /ccaas/1/working-hours Get filtered working hours #
POST /ccaas/1/working-hours Create working hours #
GET /ccaas/1/working-hours/{id} Get working hours #
PUT /ccaas/1/working-hours/{id} Update working hours #
DELETE /ccaas/1/working-hours/{id} Delete working hours #
PATCH /ccaas/1/working-hours/{id} Patch working hours #
GET /ccaas/1/working-hours/{id}/status Get working hours status #
POST /ccaas/1/working-hours/{workingHoursId}/holiday Create working hours holiday #
DELETE /ccaas/1/working-hours/{workingHoursId}/holiday/{id} Remove working hours holiday #
GET /ccaas/voice/2/tts/options/placeholders/{ttsPurpose} Get supported TTS placeholders for purpose #
GET /ccaas/voice/2/away-audio-message/{workingHoursConfigId} Get away audio message #
DELETE /ccaas/voice/2/away-audio-message/{workingHoursConfigId} Delete away audio message #
POST /ccaas/1/web-forms/{id}/submissions Submit web form data #
GET /ccaas/1/web-forms/{id} Get web form #
PUT /ccaas/1/web-forms/{id} Update web form #
DELETE /ccaas/1/web-forms/{id} Delete web form #
PATCH /ccaas/1/web-forms/{id} Patch web form #
POST /ccaas/1/web-forms Create web form #
POST /bots/1/testing/start Start test #
POST /bots/1/testing/{testId}/stop Stop test #
POST /bots/1/testing/{testId}/send-message Send message #
GET /saas/1/{resourceType}/{resourceId}/export Export SaaS resource #
POST /saas/1/{resourceType}/import Import SaaS resource #
POST /saas/1/{resourceType}/{resourceId}/share Share SaaS resource #
GET /saas/1/request/{requestId}/status Get SaaS request status #
GET /vocalize/2/campaigns/me Get my campaigns #
POST /vocalize/2/campaigns Create campaign #
GET /vocalize/2/campaigns/{campaignId} Get campaign #
DELETE /vocalize/2/campaigns/{campaignId} Delete campaign #
PATCH /vocalize/2/campaigns/{campaignId}/settings Update campaign settings #
GET /vocalize/2/campaigns/{campaignId}/leaderboard Get campaign leaderboard #
GET /vocalize/2/campaigns/{campaignId}/stats Get campaign statistics #
DELETE /vocalize/2/campaigns/{campaignId}/reset Delete campaign scores #
PUT /vocalize/2/scores Update score #
GET /vocalize/2/scores/stats Get user score statistics #
POST /knowledge-base/1/search Search knowledge base #
GET /knowledge-base/1/articles Get articles #
POST /knowledge-base/1/articles Create article #
GET /knowledge-base/1/articles/{articleId} Get article #
PUT /knowledge-base/1/articles/{articleId} Update article #
DELETE /knowledge-base/1/articles/{articleId} Delete article #
PATCH /knowledge-base/1/articles/{articleId}/status Update article status #
GET /knowledge-base/1/articles/{articleId}/history Get article versions #
GET /knowledge-base/1/articles/{articleId}/comments Get article comments #
POST /knowledge-base/1/articles/{articleId}/comments Create comment #
PUT /knowledge-base/1/articles/{articleId}/comments/{commentId} Update comment #
DELETE /knowledge-base/1/articles/{articleId}/comments/{commentId} Delete comment #
GET /knowledge-base/1/categories Get categories #
GET /knowledge-base/1/folders Get folders #
GET /knowledge-base/1/content-tree/nodes/categories Get content tree categories #
POST /knowledge-base/1/content-tree/nodes Create content tree node #
POST /knowledge-base/1/content-tree/nodes/{nodeId}/move Move content tree node #
GET /knowledge-base/1/content-tree/nodes/{nodeId} Get content tree node #
PUT /knowledge-base/1/content-tree/nodes/{nodeId} Update content tree node #
DELETE /knowledge-base/1/content-tree/nodes/{nodeId} Delete content tree node #
GET /knowledge-base/1/tags Get tags #
POST /knowledge-base/1/tags Create tag #
GET /knowledge-base/1/tags/{tagId} Get tag #
PUT /knowledge-base/1/tags/{tagId} Update tag #

Documentation

📖
Documentation
https://www.infobip.com/docs/api/platform/2fa
📖
APIReference
https://www.infobip.com/docs/api/platform/2fa
📖
Documentation
https://www.infobip.com/docs/api/platform/account-management
📖
APIReference
https://www.infobip.com/docs/api/platform/account-management
📖
Documentation
https://www.infobip.com/docs/api/ai-hub/ai-assistants
📖
APIReference
https://www.infobip.com/docs/api/ai-hub/ai-assistants
📖
Documentation
https://www.infobip.com/docs/api/customer-engagement/answers
📖
APIReference
https://www.infobip.com/docs/api/customer-engagement/answers
📖
Documentation
https://www.infobip.com/docs/api/channels/apple-mfb
📖
APIReference
https://www.infobip.com/docs/api/channels/apple-mfb
📖
Documentation
https://www.infobip.com/docs/api/platform/application-entity
📖
APIReference
https://www.infobip.com/docs/api/platform/application-entity
📖
Documentation
https://www.infobip.com/docs/api/platform/billing-usage-api
📖
APIReference
https://www.infobip.com/docs/api/platform/billing-usage-api
📖
Documentation
https://www.infobip.com/docs/api/connectivity/biometrics
📖
APIReference
https://www.infobip.com/docs/api/connectivity/biometrics
📖
Documentation
https://www.infobip.com/docs/api/platform/blocklist
📖
APIReference
https://www.infobip.com/docs/api/platform/blocklist
📖
Documentation
https://www.infobip.com/docs/api/connectivity/camara
📖
APIReference
https://www.infobip.com/docs/api/connectivity/camara
📖
Documentation
https://www.infobip.com/docs/api/platform/catalogs-api
📖
APIReference
https://www.infobip.com/docs/api/platform/catalogs-api
📖
Documentation
https://www.infobip.com/docs/api/customer-engagement/common-assets
📖
APIReference
https://www.infobip.com/docs/api/customer-engagement/common-assets
📖
Documentation
https://www.infobip.com/docs/api/customer-engagement/conversations
📖
APIReference
https://www.infobip.com/docs/api/customer-engagement/conversations
📖
Documentation
https://www.infobip.com/docs/api/channels/email
📖
APIReference
https://www.infobip.com/docs/api/channels/email
📖
Documentation
https://www.infobip.com/docs/api/channels/instagram
📖
APIReference
https://www.infobip.com/docs/api/channels/instagram
📖
Documentation
https://www.infobip.com/docs/api/channels/kakao
📖
APIReference
https://www.infobip.com/docs/api/channels/kakao
📖
Documentation
https://www.infobip.com/docs/api/customer-engagement/knowledge-base
📖
APIReference
https://www.infobip.com/docs/api/customer-engagement/knowledge-base
📖
Documentation
https://www.infobip.com/docs/api/channels/line
📖
APIReference
https://www.infobip.com/docs/api/channels/line
📖
Documentation
https://www.infobip.com/docs/api/channels/live-chat
📖
APIReference
https://www.infobip.com/docs/api/channels/live-chat
📖
Documentation
https://www.infobip.com/docs/api/platform/messages-api
📖
APIReference
https://www.infobip.com/docs/api/platform/messages-api
📖
Documentation
https://www.infobip.com/docs/api/channels/messenger
📖
APIReference
https://www.infobip.com/docs/api/channels/messenger
📖
Documentation
https://www.infobip.com/docs/api/platform/metrics-api
📖
APIReference
https://www.infobip.com/docs/api/platform/metrics-api
📖
Documentation
https://www.infobip.com/docs/api/channels/mms
📖
APIReference
https://www.infobip.com/docs/api/channels/mms
📖
Documentation
https://www.infobip.com/docs/api/channels/mobile-app-messaging
📖
APIReference
https://www.infobip.com/docs/api/channels/mobile-app-messaging
📖
Documentation
https://www.infobip.com/docs/api/connectivity/mobile-identity
📖
APIReference
https://www.infobip.com/docs/api/connectivity/mobile-identity
📖
Documentation
https://www.infobip.com/docs/api/customer-engagement/moments
📖
APIReference
https://www.infobip.com/docs/api/customer-engagement/moments
📖
Documentation
https://www.infobip.com/docs/api/connectivity/number-activation-state
📖
APIReference
https://www.infobip.com/docs/api/connectivity/number-activation-state
📖
Documentation
https://www.infobip.com/docs/api/connectivity/number-lookup
📖
APIReference
https://www.infobip.com/docs/api/connectivity/number-lookup
📖
Documentation
https://www.infobip.com/docs/api/platform/numbers
📖
APIReference
https://www.infobip.com/docs/api/platform/numbers
📖
Documentation
https://www.infobip.com/docs/api/channels/omni-failover
📖
APIReference
https://www.infobip.com/docs/api/channels/omni-failover
📖
Documentation
https://www.infobip.com/docs/api/channels/open-channel
📖
APIReference
https://www.infobip.com/docs/api/channels/open-channel
📖
Documentation
https://www.infobip.com/docs/api/tools/openapi
📖
APIReference
https://www.infobip.com/docs/api/tools/openapi
📖
Documentation
https://www.infobip.com/docs/api/customer-engagement/people
📖
APIReference
https://www.infobip.com/docs/api/customer-engagement/people
📖
Documentation
https://www.infobip.com/docs/api/channels/rcs
📖
APIReference
https://www.infobip.com/docs/api/channels/rcs
📖
Documentation
https://www.infobip.com/docs/api/platform/resources
📖
APIReference
https://www.infobip.com/docs/api/platform/resources
📖
Documentation
https://www.infobip.com/docs/api/platform/sending-strategy
📖
APIReference
https://www.infobip.com/docs/api/platform/sending-strategy
📖
Documentation
https://www.infobip.com/docs/api/platform/signals
📖
APIReference
https://www.infobip.com/docs/api/platform/signals
📖
Documentation
https://www.infobip.com/docs/api/channels/sms
📖
APIReference
https://www.infobip.com/docs/api/channels/sms
📖
Documentation
https://www.infobip.com/docs/api/platform/subscriptions-api
📖
APIReference
https://www.infobip.com/docs/api/platform/subscriptions-api
📖
Documentation
https://www.infobip.com/docs/api/channels/tiktok
📖
APIReference
https://www.infobip.com/docs/api/channels/tiktok
📖
Documentation
https://www.infobip.com/docs/api/channels/viber
📖
APIReference
https://www.infobip.com/docs/api/channels/viber
📖
Documentation
https://www.infobip.com/docs/api/customer-engagement/vocalize
📖
APIReference
https://www.infobip.com/docs/api/customer-engagement/vocalize
📖
Documentation
https://www.infobip.com/docs/api/channels/voice
📖
APIReference
https://www.infobip.com/docs/api/channels/voice
📖
Documentation
https://www.infobip.com/docs/api/channels/webrtc-calls
📖
APIReference
https://www.infobip.com/docs/api/channels/webrtc-calls
📖
Documentation
https://www.infobip.com/docs/api/channels/whatsapp
📖
APIReference
https://www.infobip.com/docs/api/channels/whatsapp
📖
Documentation
https://www.infobip.com/docs/api/channels/zalo
📖
APIReference
https://www.infobip.com/docs/api/channels/zalo

Specifications

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/infobip-customer-engagement-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

infobip-customer-engagement-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Infobip OpenAPI Specification Customer Engagement API
  description: OpenAPI Specification that contains all public endpoints and webhooks.
  contact:
    name: Infobip support
    email: support@infobip.com
  version: 3.210.0
  x-generatedAt: '2026-07-23T15:23:37.825639538Z'
tags:
- name: customer-engagement
  description: 'Complete solutions that will help you drive better outcomes for your customers and business across the entire customer journey.

    '
  x-type: category
  x-displayName: Customer Engagement
paths:
  /people/2/persons:
    get:
      tags:
      - customer-engagement
      summary: Get a single person or a list of people
      description: Use this method with a unique person identifier to get a single person. Skip the identifier to return all people or use the `filter` parameter to return a list of people matching your specific conditions.
      operationId: get-a-single-person-or-a-list-of-people
      parameters:
      - name: identifier
        in: query
        description: Person ID. ID type must match the `type` parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '370329180020364'
      - name: sender
        in: query
        description: Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '2094832040560427'
      - name: type
        in: query
        description: Type of the person ID
        required: false
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/67ea2a2f468d202db25df7b2d86e54c3628a74b47c8fd9cf8429d0e9a038dd27.PersonUniqueFieldType'
        example: PHONE
      - name: limit
        in: query
        description: Number of persons to return per page. Default - 20. Maximum - 1000.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
        example: '20'
      - name: page
        in: query
        description: Page of results to return. Default - 1.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
        example: '1'
      - name: includeTotalCount
        in: query
        description: Returns total count of persons, if set to `true`.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
        example: 'false'
      - name: orderBy
        in: query
        description: Results ordering. Possible ordering fields are `firstName`, `lastName`, `createdAt` and `modifiedAt`. Ordering direction can be specified with modifiers `asc` for the ascending ordering or `desc` for the descending one.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: modifiedAt:desc
      - name: filter
        in: query
        description: 'Allows to filter persons using simple queries. Just pass to the parameter [URL encoded](https://www.w3schools.com/tags/ref_urlencode.asp) query.

          ##### List of supported logical operators:


          <table>

          <thead>

          <th>Logical Operator</th><th>Description</th>

          </thead>

          <tr>

          <td><code>#and</code></td><td>Joins query clauses with a logical AND returns all records that match the conditions of both clauses.</td>

          </tr>

          <tr>

          <td><code>#or</code></td><td>Joins query clauses with a logical OR returns all records that match the conditions of either clause.</td>

          </tr>

          </table>


          ##### List of supported comparison operators:


          <table>

          <thead>

          <th>Comparison Operator</th><th>Supported Type</th><th>Description</th>

          </thead>

          <tr>

          <td><code>#eq</code></td><td>string, integer, decimal, date</td><td>Matches values that are equal to a specified value.</td>

          </tr>

          <tr>

          <td><code>#ne</code></td><td>string, integer, decimal, date</td><td>Matches all values that are not equal to a specified value.</td>

          </tr>

          <tr>

          <td><code>#contains</code></td><td>string</td><td>Matches the records that contain the specified value.</td>

          </tr>

          <tr>

          <td><code>#notContain</code></td><td>string</td><td>Matches the records that does not contain the specified value.</td>

          </tr>

          <tr>

          <td><code>#startsWith</code></td><td>string</td><td>Matches the records that start with a specified value.</td>

          </tr>

          <tr>

          <td><code>#endsWith</code></td><td>string</td><td>Matches the records that end with a specified value.</td>

          </tr>

          <tr>

          <td><code>#gt</code></td><td>integer, decimal, date</td><td>Matches values that are greater than a specified value.</td>

          </tr>

          <tr>

          <td><code>#lt</code></td><td>integer, decimal, date</td><td>Matches values that are less than a specified value.</td>

          </tr>

          <tr>

          <td><code>#gte</code></td><td>integer, decimal, date</td><td>Matches values that are greater than or equal to a specified value.</td>

          </tr>

          <tr>

          <td><code>#lte</code></td><td>integer, decimal, date</td><td>Matches values that are less than or equal to a specified value.</td>

          </tr>

          </table>

          '
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '{"#and":[{"firstName":"Alex"},{"#contains": { "tags":"VIP Client"}}]}}'
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
              examples:
                Person response:
                  summary: Person response
                  value:
                    createdAt: '2018-03-29T13:46:31'
                    modifiedAt: '2018-03-30T11:25:13'
                    id: 1
                    externalId: '3'
                    firstName: Jane
                    lastName: Smith
                    address: 67 Farringdon Road
                    city: London
                    country: United Kingdom
                    gender: FEMALE
                    birthDate: '1966-01-15'
                    middleName: Janie
                    preferredLanguage: en-gb
                    profilePicture: http://profile.com
                    origin: API
                    modifiedFrom: API
                    tags:
                    - VIP Customers
                    - New Customers
                    customAttributes:
                      Contract Expiry: '2018-06-01'
                      Company: Acme
                      ShoppingCartList:
                      - productName: Sneakers
                        productPrice: 25.33
                        productCategory: Sport Sneakers
                        productImage: /image1.png
                      - productName: T-Shirt
                        productPrice: 9.99
                        productCategory: Casual
                        productImage: /image2.png
                    contactInformation:
                      phone:
                      - number: '41793026727'
                      email:
                      - address: janewilliams@acme.com
                      push:
                      - applicationId: FDCC8516470A3AE97FB8AC218D5D0D3D
                        registrationId: c5db0c47-465c-4e1c-abf8-7cedc275dd19
                        additionalData:
                          birthdate: '1988-07-31'
                          email: test@test.com
                          firstName: Jane
                          gender: F
                          lastName: Smith
                          middleName: Janie
                        systemData:
                          cloudType: GCM
                          registrationEnabled: 'true'
                          sdkName: MobileMessaging SDK
                          os: Android
                      facebook:
                      - applicationId: '370329180020364'
                        userId: '2094832040560427'
                        systemData:
                          gender: female
                          lastName: Smith
                          firstName: Jane
                      line:
                      - applicationId: '1644264921'
                        userId: U045147f1ad961bfe996b72bbf417f3c9
                        systemData:
                          displayName: Jane Smith
                      instagram:
                      - applicationId: '17841446795352028'
                        userId: '12461436693342628'
                        systemData:
                          displayName: jane.smith
                      twitter:
                      - applicationId: '1148203323283877'
                        userId: '370329180020364'
                        systemData:
                          displayName: Jane Smith
                      appleBusinessChat:
                      - applicationId: '387465931'
                        userId: '387465931'
                        systemData:
                          displayName: Jane Smith
                      zaloFollower:
                      - applicationId: '12345678901'
                        userId: '9876543210'
                        systemData:
                          displayName: Jane Smith
                      tiktokBm:
                      - applicationId: '7012345678901234567'
                        userId: '7123456789012345678'
                        systemData:
                          displayName: Jane Smith
                      whatsapp:
                      - applicationId: '441234567890'
                        userId: US.13491208655302741918
                        systemData:
                          username: jane.smith
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
              examples:
                Person response:
                  summary: Person response
                  value: <?xml version='1.0' encoding='UTF-8'?><IamPersonV2><createdAt>2018-03-29T13:46:31</createdAt><modifiedAt>2018-03-30T11:25:13</modifiedAt><id>1</id><externalId>3</externalId><firstName>Jane</firstName><lastName>Smith</lastName><address>67 Farringdon Road</address><city>London</city><country>United Kingdom</country><gender>FEMALE</gender><birthDate>1966-01-15</birthDate><middleName>Janie</middleName><preferredLanguage>en-gb</preferredLanguage><profilePicture>http://profile.com</profilePicture><origin>API</origin><modifiedFrom>API</modifiedFrom><tags><tags>VIP Customers</tags><tags>New Customers</tags></tags><customAttributes><Contract Expiry>2018-06-01</Contract Expiry><Company>Acme</Company><ShoppingCartList><productName>Sneakers</productName><productPrice>25.33</productPrice><productCategory>Sport Sneakers</productCategory><productImage>/image1.png</productImage></ShoppingCartList><ShoppingCartList><productName>T-Shirt</productName><productPrice>9.99</productPrice><productCategory>Casual</productCategory><productImage>/image2.png</productImage></ShoppingCartList></customAttributes><contactInformation><phone><phone><number>41793026727</number></phone></phone><email><email><address>janewilliams@acme.com</address></email></email><push><push><applicationId>FDCC8516470A3AE97FB8AC218D5D0D3D</applicationId><registrationId>c5db0c47-465c-4e1c-abf8-7cedc275dd19</registrationId><additionalData><birthdate>1988-07-31</birthdate><email>test@test.com</email><firstName>Jane</firstName><gender>F</gender><lastName>Smith</lastName><middleName>Janie</middleName></additionalData><systemData><cloudType>GCM</cloudType><registrationEnabled>true</registrationEnabled><sdkName>MobileMessaging SDK</sdkName><os>Android</os></systemData></push></push><facebook><facebook><applicationId>370329180020364</applicationId><userId>2094832040560427</userId><systemData><gender>female</gender><lastName>Smith</lastName><firstName>Jane</firstName></systemData></facebook></facebook><line><line><applicationId>1644264921</applicationId><userId>U045147f1ad961bfe996b72bbf417f3c9</userId><systemData><displayName>Jane Smith</displayName></systemData></line></line><instagram><instagram><applicationId>17841446795352028</applicationId><userId>12461436693342628</userId><systemData><displayName>jane.smith</displayName></systemData></instagram></instagram><twitter><twitter><applicationId>1148203323283877</applicationId><userId>370329180020364</userId><systemData><displayName>Jane Smith</displayName></systemData></twitter></twitter><appleBusinessChat><appleBusinessChat><applicationId>387465931</applicationId><userId>387465931</userId><systemData><displayName>Jane Smith</displayName></systemData></appleBusinessChat></appleBusinessChat><zaloFollower><zaloFollower><applicationId>12345678901</applicationId><userId>9876543210</userId><systemData><displayName>Jane Smith</displayName></systemData></zaloFollower></zaloFollower><tiktokBm><tiktokBm><applicationId>7012345678901234567</applicationId><userId>7123456789012345678</userId><systemData><displayName>Jane Smith</displayName></systemData></tiktokBm></tiktokBm><whatsapp><whatsapp><applicationId>441234567890</applicationId><userId>US.13491208655302741918</userId><systemData><username>jane.smith</username></systemData></whatsapp></whatsapp></contactInformation></IamPersonV2>
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      - people:read
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    put:
      tags:
      - customer-engagement
      summary: Update a person
      description: Use this method to overwrite a person profile with the data passed in the request body as follows:<br>1. New values for standard and custom profile attributes replace existing values on the profile. If no value is passed in the request, the attribute is set to empty.<br>2. Tags in the request replace the existing profile tags. If no tags are passed, the existing profile tag list is cleared.<br>3. New contact information (email addresses and phone numbers) in the request replaces the current information on the profile.
      operationId: update-a-person
      parameters:
      - name: identifier
        in: query
        description: Person ID. ID type must match the `type` parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '370329180020364'
      - name: sender
        in: query
        description: Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '2094832040560427'
      - name: type
        in: query
        description: Type of the person ID
        required: false
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/67ea2a2f468d202db25df7b2d86e54c3628a74b47c8fd9cf8429d0e9a038dd27.PersonUniqueFieldType'
        example: PHONE
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
            examples:
              Update person with list:
                summary: Update person with list
                value:
                  firstName: Jane
                  lastName: Smith
                  customAttributes:
                    Contract Expiry: '2018-06-01'
                    Company: Acme
                    ShoppingCartList:
                    - productName: Sneakers
                      productPrice: 25.33
                      productCategory: Sport Sneakers
                      productImage: /image1.png
                    - productName: T-Shirt
                      productPrice: 9.99
                      productCategory: Casual
                      productImage: /image2.png
                  contactInformation:
                    email:
                    - address: janewilliams@acme.com
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
            examples:
              Update person with list:
                summary: Update person with list
                value: <?xml version='1.0' encoding='UTF-8'?><IamPersonV2><firstName>Jane</firstName><lastName>Smith</lastName><customAttributes><Contract Expiry>2018-06-01</Contract Expiry><Company>Acme</Company><ShoppingCartList><productName>Sneakers</productName><productPrice>25.33</productPrice><productCategory>Sport Sneakers</productCategory><productImage>/image1.png</productImage></ShoppingCartList><ShoppingCartList><productName>T-Shirt</productName><productPrice>9.99</productPrice><productCategory>Casual</productCategory><productImage>/image2.png</productImage></ShoppingCartList></customAttributes><contactInformation><email><email><address>janewilliams@acme.com</address></email></email></contactInformation></IamPersonV2>
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
              examples:
                Person response:
                  summary: Person response
                  value:
                    createdAt: '2018-03-29T13:46:31'
                    modifiedAt: '2018-03-30T11:25:13'
                    id: 1
                    externalId: '3'
                    firstName: Jane
                    lastName: Smith
                    address: 67 Farringdon Road
                    city: London
                    country: United Kingdom
                    gender: FEMALE
                    birthDate: '1966-01-15'
                    middleName: Janie
                    preferredLanguage: en-gb
                    profilePicture: http://profile.com
                    origin: API
                    modifiedFrom: API
                    tags:
                    - VIP Customers
                    - New Customers
                    customAttributes:
                      Contract Expiry: '2018-06-01'
                      Company: Acme
                      ShoppingCartList:
                      - productName: Sneakers
                        productPrice: 25.33
                        productCategory: Sport Sneakers
                        productImage: /image1.png
                      - productName: T-Shirt
                        productPrice: 9.99
                        productCategory: Casual
                        productImage: /image2.png
                    contactInformation:
                      phone:
                      - number: '41793026727'
                      email:
                      - address: janewilliams@acme.com
                      push:
                      - applicationId: FDCC8516470A3AE97FB8AC218D5D0D3D
                        registrationId: c5db0c47-465c-4e1c-abf8-7cedc275dd19
                        additionalData:
                          birthdate: '1988-07-31'
                          email: test@test.com
                          firstName: Jane
                          gender: F
                          lastName: Smith
                          middleName: Janie
                        systemData:
                          cloudType: GCM
                          registrationEnabled: 'true'
                          sdkName: MobileMessaging SDK
                          os: Android
                      facebook:
                      - applicationId: '370329180020364'
                        userId: '2094832040560427'
                        systemData:
                          gender: female
                          lastName: Smith
                          firstName: Jane
                      line:
                      - applicationId: '1644264921'
                        userId: U045147f1ad961bfe996b72bbf417f3c9
                        systemData:
                          displayName: Jane Smith
                      instagram:
                      - applicationId: '17841446795352028'
                        userId: '12461436693342628'
                        systemData:
                          displayName: jane.smith
                      twitter:
                      - applicationId: '1148203323283877'
                        userId: '370329180020364'
                        systemData:
                          displayName: Jane Smith
                      appleBusinessChat:
                      - applicationId: '387465931'
                        userId: '387465931'
                        systemData:
                          displayName: Jane Smith
                      zaloFollower:
                      - applicationId: '12345678901'
                        userId: '9876543210'
                        systemData:
                          displayName: Jane Smith
                      tiktokBm:
                      - applicationId: '7012345678901234567'
                        userId: '7123456789012345678'
                        systemData:
                          displayName: Jane Smith
                      whatsapp:
                      - applicationId: '441234567890'
                        userId: US.13491208655302741918
                        systemData:
                          username: jane.smith
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
              examples:
                Person response:
                  summary: Person response
                  value: <?xml version='1.0' encoding='UTF-8'?><IamPersonV2><createdAt>2018-03-29T13:46:31</createdAt><modifiedAt>2018-03-30T11:25:13</modifiedAt><id>1</id><externalId>3</externalId><firstName>Jane</firstName><lastName>Smith</lastName><address>67 Farringdon Road</address><city>London</city><country>United Kingdom</country><gender>FEMALE</gender><birthDate>1966-01-15</birthDate><middleName>Janie</middleName><preferredLanguage>en-gb</preferredLanguage><profilePicture>http://profile.com</profilePicture><origin>API</origin><modifiedFrom>API</modifiedFrom><tags><tags>VIP Customers</tags><tags>New Customers</tags></tags><customAttributes><Contract Expiry>2018-06-01</Contract Expiry><Company>Acme</Company><ShoppingCartList><productName>Sneakers</productName><productPrice>25.33</productPrice><productCategory>Sport Sneakers</productCategory><productImage>/image1.png</productImage></ShoppingCartList><ShoppingCartList><productName>T-Shirt</productName><productPrice>9.99</productPrice><productCategory>Casual</productCategory><productImage>/image2.png</productImage></ShoppingCartList></customAttributes><contactInformation><phone><phone><number>41793026727</number></phone></phone><email><email><address>janewilliams@acme.com</address></email></email><push><push><applicationId>FDCC8516470A3AE97FB8AC218D5D0D3D</applicationId><registrationId>c5db0c47-465c-4e1c-abf8-7cedc275dd19</registrationId><additionalData><birthdate>1988-07-31</birthdate><email>test@test.com</email><firstName>Jane</firstName><gender>F</gender><lastName>Smith</lastName><middleName>Janie</middleName></additionalData><systemData><cloudType>GCM</cloudType><registrationEnabled>true</registrationEnabled><sdkName>MobileMessaging SDK</sdkName><os>Android</os></systemData></push></push><facebook><facebook><applicationId>370329180020364</applicationId><userId>2094832040560427</userId><systemData><gender>female</gender><lastName>Smith</lastName><firstName>Jane</firstName></systemData></facebook></facebook><line><line><applicationId>1644264921</applicationId><userId>U045147f1ad961bfe996b72bbf417f3c9</userId><systemData><displayName>Jane Smith</displayName></systemData></line></line><instagram><instagram><applicationId>17841446795352028</applicationId><userId>12461436693342628</userId><systemData><displayName>jane.smith</displayName></systemData></instagram></instagram><twitter><twitter><applicationId>1148203323283877</applicationId><userId>370329180020364</userId><systemData><displayName>Jane Smith</displayName></systemData></twitter></twitter><appleBusinessChat><appleBusinessChat><applicationId>387465931</applicationId><userId>387465931</userId><systemData><displayName>Jane Smith</displayName></systemData></appleBusinessChat></appleBusinessChat><zaloFollower><zaloFollower><applicationId>12345678901</applicationId><userId>9876543210</userId><systemData><displayName>Jane Smith</displayName></systemData></zaloFollower></zaloFollower><tiktokBm><tiktokBm><applicationId>7012345678901234567</applicationId><userId>7123456789012345678</userId><systemData><displayName>Jane Smith</displayName></systemData></tiktokBm></tiktokBm><whatsapp><whatsapp><applicationId>441234567890</applicationId><userId>US.13491208655302741918</userId><systemData><username>jane.smith</username></systemData></whatsapp></whatsapp></contactInformation></IamPersonV2>
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - people:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - customer-engagement
      summary: Create a new person
      description: Use this method to create a new person.
      operationId: create-a-new-person
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
            examples:
              Create person with list:
                summary: Create person with list
                value:
                  firstName: Jane
                  lastName: Smith
                  customAttributes:
                    Contract Expiry: '2018-06-01'
                    Company: Acme
                    ShoppingCartList:
                    - productName: Sneakers
                      productPrice: 25.33
                      productCategory: Sport Sneakers
                      productImage: /image1.png
                    - productName: T-Shirt
                      productPrice: 9.99
                      productCategory: Casual
                      productImage: /image2.png
                  contactInformation:
                    email:
                    - address: janewilliams@acme.com
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
            examples:
              Create person with list:
                summary: Create person with list
                value: <?xml version='1.0' encoding='UTF-8'?><IamPersonV2><firstName>Jane</firstName><lastName>Smith</lastName><customAttributes><Contract Expiry>2018-06-01</Contract Expiry><Company>Acme</Company><ShoppingCartList><productName>Sneakers</productName><productPrice>25.33</productPrice><productCategory>Sport Sneakers</productCategory><productImage>/image1.png</productImage></ShoppingCartList><ShoppingCartList><productName>T-Shirt</productName><productPrice>9.99</productPrice><productCategory>Casual</productCategory><productImage>/image2.png</productImage></ShoppingCartList></customAttributes><contactInformation><email><email><address>janewilliams@acme.com</address></email></email></contactInformation></IamPersonV2>
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2'
              examples:
                Person response:
                  summary: Person response
                  value:
                    createdAt: '2018-03-29T13:46:31'
                    modifiedAt: '2018-03-30T11:25:13'
                    id: 1
                    externalId: '3'
                    firstName: Jane
                    lastName: Smith
                    address: 67 Farringdon Road
                    city: London
                    country: United Kingdom
                    gender: FEMALE
                    birthDate: '1966-01-15'
                    middleName: Janie
                    preferredLanguage: en-gb
                    profilePicture: http://profile.com
                    origin: API
                    modifiedFrom: API
                    tags:
                    - VIP Customers
                    - New Customers
                    customAttributes:
                      Contract Expiry: '2018-06-01'
                      Company: Acme
                      ShoppingCartList:
                      - productName: Sneakers
                        

# --- truncated at 32 KB (1619 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/infobip/refs/heads/main/openapi/infobip-customer-engagement-api-openapi.yml