{ "info": { "name": "Pinlyx Public API v1", "description": "Generated from the live OpenAPI document at https://api.crmsolid.com/v1/v1/openapi.json.\n\nSet the `apiKey` variable to a key from Settings > API Keys (starts with csk_live_). Field names are PascalCase; that is deliberate, the API does not camel-case its DTOs.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "baseUrl", "value": "https://api.crmsolid.com" }, { "key": "apiKey", "value": "csk_live_replace_me" }, { "key": "accountId", "value": "1" }, { "key": "contactId", "value": "1" } ], "item": [ { "name": "Identity", "item": [ { "name": "Who am I", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/me", "host": [ "{{baseUrl}}" ], "path": [ "v1", "me" ] }, "description": "Confirms the key works and shows its scopes." } }, { "name": "List accounts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/accounts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "accounts" ] }, "description": "" } } ] }, { "name": "Contacts", "item": [ { "name": "List contacts", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/contacts?page=1&pageSize=50", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts" ], "query": [ { "key": "page", "value": "1" }, { "key": "pageSize", "value": "50" } ] }, "description": "" } }, { "name": "Create contact", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/contacts", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts" ] }, "description": "Upserts on ExternalId when you supply one.", "body": { "mode": "raw", "raw": "{\n \"Platform\": \"telegram\",\n \"Name\": \"Ada Lovelace\",\n \"Username\": \"ada\",\n \"Email\": \"ada@example.com\",\n \"Company\": \"Analytical Engines\",\n \"Country\": \"GB\",\n \"Tags\": [\n \"inbound\",\n \"pricing-intent\"\n ],\n \"LeadScore\": 60,\n \"Source\": \"api\"\n}" } } }, { "name": "Get contact", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/contacts/{{contactId}}", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts", "{{contactId}}" ] }, "description": "" } }, { "name": "Set lead score", "request": { "method": "PUT", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/contacts/{{contactId}}/score", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts", "{{contactId}}", "score" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"Score\": 85\n}" } } }, { "name": "Add tag", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/contacts/{{contactId}}/tags", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts", "{{contactId}}", "tags" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"Tag\": \"hot\"\n}" } } }, { "name": "Activity timeline", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/contacts/{{contactId}}/activities", "host": [ "{{baseUrl}}" ], "path": [ "v1", "contacts", "{{contactId}}", "activities" ] }, "description": "" } } ] }, { "name": "Messaging", "item": [ { "name": "Send Telegram message", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/telegram/messages", "host": [ "{{baseUrl}}" ], "path": [ "v1", "telegram", "messages" ] }, "description": "Queues a send. Poll /v1/jobs/{id} for delivery state. RunAt schedules it instead.", "body": { "mode": "raw", "raw": "{\n \"AccountId\": 1,\n \"ContactId\": 1,\n \"Text\": \"Hi Ada, following up on your question about the shared inbox.\"\n}" } } }, { "name": "Send X DM", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/twitter/messages", "host": [ "{{baseUrl}}" ], "path": [ "v1", "twitter", "messages" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"XAccountId\": 1,\n \"ContactId\": 1,\n \"Text\": \"Thanks for the follow.\"\n}" } } }, { "name": "Send social message", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/social/conversations/{{contactId}}/messages", "host": [ "{{baseUrl}}" ], "path": [ "v1", "social", "conversations", "{{contactId}}", "messages" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"Text\": \"Your order shipped.\",\n \"IdempotencyKey\": \"{{$guid}}\"\n}" } } }, { "name": "Conversations", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/conversations", "host": [ "{{baseUrl}}" ], "path": [ "v1", "conversations" ] }, "description": "" } } ] }, { "name": "Pipeline", "item": [ { "name": "List pipelines", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/pipelines", "host": [ "{{baseUrl}}" ], "path": [ "v1", "pipelines" ] }, "description": "" } }, { "name": "List deals", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/deals", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deals" ] }, "description": "" } }, { "name": "Create deal", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/deals", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deals" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"ContactId\": 1,\n \"Title\": \"Analytical Engines - 5 seats\",\n \"Value\": 1250,\n \"Currency\": \"USD\"\n}" } } }, { "name": "Move deal stage", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/deals/1/stage", "host": [ "{{baseUrl}}" ], "path": [ "v1", "deals", "1", "stage" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"Stage\": \"proposal\"\n}" } } } ] }, { "name": "Sequences", "item": [ { "name": "List sequences", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/sequences", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sequences" ] }, "description": "Read, pause and resume are exposed. Enrolment happens in the panel or by segment rule, not over the API." } }, { "name": "Pause sequence", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/sequences/1/pause", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sequences", "1", "pause" ] }, "description": "" } }, { "name": "Resume sequence", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/sequences/1/resume", "host": [ "{{baseUrl}}" ], "path": [ "v1", "sequences", "1", "resume" ] }, "description": "" } } ] }, { "name": "Webhooks", "item": [ { "name": "List event types", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/event-types", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", "event-types" ] }, "description": "" } }, { "name": "Create endpoint", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Idempotency-Key", "value": "{{$guid}}" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks" ] }, "description": "", "body": { "mode": "raw", "raw": "{\n \"Url\": \"https://example.com/hooks/pinlyx\",\n \"EventTypes\": [\n \"message.received\",\n \"contact.created\",\n \"deal.won\"\n ],\n \"Description\": \"Production listener\"\n}" } } }, { "name": "Send test delivery", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/1/test", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", "1", "test" ] }, "description": "" } }, { "name": "Delivery log", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/1/deliveries", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", "1", "deliveries" ] }, "description": "" } }, { "name": "Rotate secret", "request": { "method": "POST", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/webhooks/1/rotate-secret", "host": [ "{{baseUrl}}" ], "path": [ "v1", "webhooks", "1", "rotate-secret" ] }, "description": "" } } ] }, { "name": "Jobs and analytics", "item": [ { "name": "List jobs", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/jobs", "host": [ "{{baseUrl}}" ], "path": [ "v1", "jobs" ] }, "description": "" } }, { "name": "Job status", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/jobs/1", "host": [ "{{baseUrl}}" ], "path": [ "v1", "jobs", "1" ] }, "description": "" } }, { "name": "Analytics summary", "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{apiKey}}" }, { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/analytics/summary", "host": [ "{{baseUrl}}" ], "path": [ "v1", "analytics", "summary" ] }, "description": "" } } ] } ] }