FORMAT: 1A # Contacts Management API The Contacts Management API provides the necessary endpoints to manage your contacts. ## Overview The API provides access to two main resources: * **Contacts**: Data associated with the individuals you need to contact. * **Lists**: Groups of contacts created for specific purposes. ## Base URI The API uses the following base URI: ``` https://api.messaging.tpgtelecom.com.au``` ## Authentication All requests to the Contacts REST API must be authenticated, this can either be done using Basic Authentication or by signing with a HMAC signature. ### Credentials To access the API, an API key and secret are required. ### Basic Authentication Every request requires an `Authorization` header in the following format: ```plain Authorization: Basic Base64(api_key:api_secret) ``` Where the header consists of the Basic keyword followed by your Basic Authentication `api_key` and `api_secret` that you have been supplied by support, seperated with a colon (:) which is then Base64 encoded. #### Example request with Basic Authentication ```plain POST /api/v1/contacts/contacts HTTP/1.1 Host: api.messaging.tpgtelecom.com.au Accept: application/json Content-Type: application/json Authorization: Basic dGhpc2lzYWtleTp0aGlzaXNhc2VjcmV0Zm9ybW1iYXNpY2F1dGhyZXN0YXBp { "firstName": "Adam", "lastName": "Smith", "channels": [ { "channelId": "+15553456783", "type": "PHONE", "subscriptionState": "UNSUBSCRIBED" } ], "lists": [ { "name": "My group", "alias": "Group1" } ], "customFields": [ { "id": "025e93d3-051b-43f9-b12e-4b5842228dee", "value": "John" } } ``` _Note: spaces are used as indentation in the body of the above request._ ### HMAC Authentication Every request requires an `Authorization` header in the following formats: For a request with a request body: ```plain Authorization: hmac username="", algorithm="hmac-sha1", headers="Date Content-MD5 request-line", signature="" ``` For a request _without_ a request body: ```plain Authorization: hmac username="", algorithm="hmac-sha1", headers="Date request-line", signature="" ``` #### To create this header ##### Step 1 Add a `Date` header to the request using the current date time in [RFC7231 Section 7.1.1.2](http://tools.ietf.org/html/rfc7231#section-7.1.1.2) format ##### Step 2 If the request has a body, add a header called `Content-MD5` where the value of this header is an MD5 hash of the request body, otherwise this header is not required ##### Step 3 Create a signing string by concatenating the `Date` header, the `Content-MD5` header (if set) and the request line with line breaks: ```plain Date: Sat, 30 Jul 2016 05:13:23 GMT\nContent-MD5: 10fd4feab20d38432480c07301e49616\nPOST /api/v1/contacts HTTP/1.1 ``` or ```plain Date: Sat, 30 Jul 2016 05:13:23 GMT\nGET /api/v1/contacts/404b941b-2a29-469f-b114-9ea3e16bbe18 HTTP/1.1 ``` ##### Step 4 Create a SHA1 HMAC hash using the signing string and the secret key (both converted to bytes using UTF-8) ```HMAC-SHA1(signing string, secret)``` ##### Step 5 Base64 encode the HMAC hash and include it as the signature in the ```Authorization``` header #### Example request with body ```plain POST /api/v1/contacts HTTP/1.1 Host: api.messaging.tpgtelecom.com.au Accept: application/json Content-Type: application/json Date: Sat, 30 Jul 2016 05:18:52 GMT Authorization: hmac username="uCXUdoogNfCsehEClbO2", algorithm="hmac-sha1", headers="Date Content-MD5 request-line", signature="Ia4G5lkhH/3NDYpix+8ZHUnp6bA=" Content-MD5: 5407644fa83bec240dede971307e0cad Content-Length: 133 { // Payload } ``` _Note: spaces are used as indentation in the body of the above request._ #### Example request without body ```plain POST /api/v1/contacts HTTP/1.1 Host: api.messaging.tpgtelecom.com.au Accept: application/json Content-Type: application/json Date: Sat, 30 Jul 2016 05:18:52 GMT Authorization: hmac username="uCXUdoogNfCsehEClbO2", algorithm="hmac-sha1", headers="Date request-line", signature="NTUwMjUwNTVmZGYzZTIxODMyYjc1ZmM3M2EwZWQ1NzA3NzA4ZTZjNw==" Content-Length: 133 { // Payload } ``` #Contacts [/api/v1/contacts/contacts] ## Create Contact [POST /api/v1/contacts/contacts] Create a new contact using the specified parameters. If one or more lists are provided, the contact will be assigned to them. If the contact is created with a SUBSCRIBED status but was previously UNSUBSCRIBED, the contact will be created as UNSUBSCRIBED. However, the contact can be re-subscribed later if needed. + Request (application/json) + Body { "firstName": "Adam", "lastName": "Smith", "alias": "user1234", "dateOfBirth": "2022-08-18", "country": "US", "state": "CA", "location": "Sunset Blvd", "note": "Note", "channels": [ { "channelId": "+15553456783", "type": "SMS", "subscriptionState": "UNSUBSCRIBED" } ], "lists": [ { "id": "025e93d3-051b-43f9-b12e-4b5842228dee" } ], "customFields": [ { "id": "025e93d3-051b-43f9-b12e-4b5842228dee", "value": "John" } ] } + Schema { "required": [ "channels" ], "type": "object", "properties": { "firstName": { "type": "string", "description": "Contact first name", "example": "Adam" }, "lastName": { "type": "string", "description": "Contact last name", "example": "Smith" }, "alias": { "type": "string", "description": "Contact alias. Used as an alternative name for your contact, as well as an email handle for email to sms", "example": "user1234" }, "dateOfBirth": { "type": "string", "description": "Date of birth", "format": "date", "example": "2022-08-18" }, "country": { "type": "string", "description": "Country", "example": "US" }, "state": { "type": "string", "description": "State", "example": "CA" }, "location": { "type": "string", "description": "Location", "example": "Sunset Blvd" }, "note": { "type": "string", "description": "Note", "example": "Note" }, "channels": { "type": "array", "description": "Contact channels", "items": { "required": [ "channelId", "type" ], "type": "object", "properties": { "channelId": { "type": "string", "description": "Contact channel id (in case phone number - in E164 international format)", "example": "+15553456783" }, "type": { "type": "string", "description": "Contact channel type", "example": "SMS", "enum": [ "SMS", "WHATSAPP" ] }, "subscriptionState": { "type": "string", "description": "Subscription state", "example": "UNSUBSCRIBED", "enum": [ "SUBSCRIBED", "UNSUBSCRIBED" ] } }, "description": "Contact channel create payload" } }, "lists": { "type": "array", "description": "Contact lists", "items": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "List id in UUID format", "format": "uuid", "example": "025e93d3-051b-43f9-b12e-4b5842228dee" } }, "description": "Contact list create payload" } }, "customFields": { "type": "array", "description": "Contact custom fields", "items": { "required": [ "id", "value" ], "type": "object", "properties": { "id": { "type": "string", "description": "Custom Field id in UUID format", "format": "uuid", "example": "025e93d3-051b-43f9-b12e-4b5842228dee" }, "value": { "type": "string", "description": "Custom field value", "example": "John" } }, "description": "Contact custom field create payload" } } }, "description": "Contact create payload" } + Response 201 (application/json) Contact succesfully created + Body { "id": "025e93d3-051b-43f9-b12e-4b5842228dee", "accountId": "string", "vendorId": "string", "firstName": "Adam", "lastName": "Smith", "fullName": "Adam Smith", "alias": "VIP contact", "dateOfBirth": "2022-08-18", "country": "US", "state": "CA", "location": "Sunset Blvd", "note": "Note", "createdDate": "2022-08-18T09:15:03.112Z", "lastModifiedDate": "2022-08-18T09:15:03.112Z", "customFields": [ { "id": "025e93d3-051b-43f9-b12e-4b5842228dee", "mergeTag": "contact_name", "value": "John", "type": "DATE" } ], "channels": [ { "channelId": "+15553456783", "type": "SMS", "subscriptionState": "UNSUBSCRIBED" } ], "lists": [ { "id": "025e93d3-051b-43f9-b12e-4b5842228dee", "name": "My list" } ] } + Schema { "required": [ "accountId", "alias", "channels", "country", "createdDate", "customFields", "firstName", "fullName", "id", "lastModifiedDate", "lastName", "lists", "location", "note", "state", "vendorId" ], "type": "object", "properties": { "id": { "type": "string", "description": "Contact id in UUID format", "format": "uuid", "example": "025e93d3-051b-43f9-b12e-4b5842228dee" }, "accountId": { "type": "string", "description": "Account id" }, "vendorId": { "type": "string", "description": "Vendor id" }, "firstName": { "type": "string", "description": "Contact first name", "example": "Adam" }, "lastName": { "type": "string", "description": "Contact last name", "example": "Smith" }, "fullName": { "type": "string", "description": "Contact full name", "example": "Adam Smith" }, "alias": { "type": "string", "description": "Contact alias", "example": "VIP contact" }, "dateOfBirth": { "type": "string", "description": "Date of birth", "format": "date", "example": "2022-08-18" }, "country": { "type": "string", "description": "Country", "example": "US" }, "state": { "type": "string", "description": "State", "example": "CA" }, "location": { "type": "string", "description": "Location", "example": "Sunset Blvd" }, "note": { "type": "string", "description": "Note", "example": "Note" }, "createdDate": { "type": "string", "description": "Create date", "format": "date-time", "example": "2022-08-18T09:15:03.112Z" }, "lastModifiedDate": { "type": "string", "description": "Last modified date", "format": "date-time", "example": "2022-08-18T09:15:03.112Z" }, "customFields": { "type": "array", "description": "List of custom fields", "items": { "$ref": { "required": [ "id", "mergeTag", "type", "value" ], "type": "object", "properties": { "id": { "type": "string", "description": "Custom Field id in UUID format", "format": "uuid", "example": "025e93d3-051b-43f9-b12e-4b5842228dee" }, "mergeTag": { "type": "string", "description": "Custom field merge tag", "example": "contact_name" }, "value": { "type": "string", "description": "Custom field value", "example": "John" }, "type": { "type": "string", "description": "Custom field type", "example": "DATE", "enum": [ "DATE", "NUMBER", "PHONE", "TEXT", "URL", "ZIP_CODE", "NAME", "EMAIL" ] } }, "description": "Custom field data" } } }, "channels": { "type": "array", "description": "Contact channels", "items": { "required": [ "channelId", "type" ], "type": "object", "properties": { "channelId": { "type": "string", "description": "Contact channel id (in case phone number - in E164 international format)", "example": "+15553456783" }, "type": { "type": "string", "description": "Contact channel type", "example": "SMS", "enum": [ "SMS", "WHATSAPP", "GBM", "INSTAGRAM", "FACEBOOK", "EMAIL" ] }, "subscriptionState": { "type": "string", "description": "Subscription state", "example": "UNSUBSCRIBED", "enum": [ "SUBSCRIBED", "UNSUBSCRIBED" ] } }, "description": "Contact channel data" } }, "lists": { "type": "array", "description": "Contact lists", "items": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "List id in UUID format", "format": "uuid", "example": "025e93d3-051b-43f9-b12e-4b5842228dee" }, "name": { "type": "string", "description": "List name", "example": "My list" } }, "description": "Contact list data" } } }, "description": "Contact data" } + Response 400 (application/json) Request has incorrect values + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "validation", "title": "string", "detail": "string", "invalidFields": [ { "name": "string", "channelType": "PHONE", "code": "must_not_be_empty", "reason": "string", "invalidIds": [ "string" ] } ] } + Schema { "required": [ "detail", "invalidFields", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" }, "invalidFields": { "type": "array", "description": "List of invalid fields", "items": { "$ref": "#/components/schemas/InvalidInputField" } } }, "description": "Invalid input error data" } + Response 401 No valid authentication details were provided + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unauthorized", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 403 The authenticated user or account doesn't have permission + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "forbidden", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 409 (application/json) Conflict. The contact already exists. + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "conflict", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 500 (application/json) Internal server error + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "internal_server_error", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 501 (application/json) Request not recognised + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "request_not_recognised", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 502 (application/json) Invalid server response + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "bad_gateway", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 503 (application/json) Server currently unavailable + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 504 (application/json) Gateway time out + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } ## Get Contact [GET /api/v1/contacts/contacts/{contactId}] Retrieve a contact based on the contactId. ContactId is unique. + Parameters + contactId: `3fa85f64-5717-4562-b3fc-2c963f66afa6` (String, required) - The unique identifier for a contact in UUID format + Response 200 (application/json) Contact requested data + Body { "id": "025e93d3-051b-43f9-b12e-4b5842228dee", "accountId": "string", "vendorId": "string", "firstName": "Adam", "lastName": "Smith", "fullName": "Adam Smith", "alias": "VIP contact", "dateOfBirth": "2022-08-18", "country": "US", "state": "CA", "location": "Sunset Blvd", "note": "Note", "createdDate": "2022-08-18T09:15:03.112Z", "lastModifiedDate": "2022-08-18T09:15:03.112Z", "customFields": [ { "id": "025e93d3-051b-43f9-b12e-4b5842228dee", "mergeTag": "contact_name", "value": "John", "type": "DATE" } ], "channels": [ { "channelId": "+15553456783", "type": "SMS", "subscriptionState": "UNSUBSCRIBED" } ], "lists": [ { "id": "025e93d3-051b-43f9-b12e-4b5842228dee", } ] } + Schema { "required": [ "accountId", "alias", "channels", "country", "createdDate", "customFields", "firstName", "fullName", "id", "lastModifiedDate", "lastName", "lists", "location", "note", "state", "vendorId" ], "type": "object", "properties": { "id": { "type": "string", "description": "Contact id in UUID format", "format": "uuid", "example": "025e93d3-051b-43f9-b12e-4b5842228dee" }, "accountId": { "type": "string", "description": "Account id" }, "vendorId": { "type": "string", "description": "Vendor id" }, "firstName": { "type": "string", "description": "Contact first name", "example": "Adam" }, "lastName": { "type": "string", "description": "Contact last name", "example": "Smith" }, "fullName": { "type": "string", "description": "Contact full name", "example": "Adam Smith" }, "alias": { "type": "string", "description": "Contact alias", "example": "VIP contact" }, "dateOfBirth": { "type": "string", "description": "Date of birth", "format": "date", "example": "2022-08-18" }, "country": { "type": "string", "description": "Country", "example": "US" }, "state": { "type": "string", "description": "State", "example": "CA" }, "location": { "type": "string", "description": "Location", "example": "Sunset Blvd" }, "note": { "type": "string", "description": "Note", "example": "Note" }, "createdDate": { "type": "string", "description": "Create date", "format": "date-time", "example": "2022-08-18T09:15:03.112Z" }, "lastModifiedDate": { "type": "string", "description": "Last modified date", "format": "date-time", "example": "2022-08-18T09:15:03.112Z" }, "customFields": { "type": "array", "description": "List of custom fields", "items": { "$ref": { "required": [ "id", "mergeTag", "type", "value" ], "type": "object", "properties": { "id": { "type": "string", "description": "Custom Field id in UUID format", "format": "uuid", "example": "025e93d3-051b-43f9-b12e-4b5842228dee" }, "mergeTag": { "type": "string", "description": "Custom field merge tag", "example": "contact_name" }, "value": { "type": "string", "description": "Custom field value", "example": "John" }, "type": { "type": "string", "description": "Custom field type", "example": "DATE", "enum": [ "DATE", "NUMBER", "PHONE", "TEXT", "URL", "ZIP_CODE", "NAME", "EMAIL" ] } }, "description": "Custom field data" } } }, "channels": { "type": "array", "description": "Contact channels", "items": { "required": [ "channelId", "type" ], "type": "object", "properties": { "channelId": { "type": "string", "description": "Contact channel id (in case phone number - in E164 international format)", "example": "+15553456783" }, "type": { "type": "string", "description": "Contact channel type", "example": "SMS", "enum": [ "SMS", "WHATSAPP", "GBM", "INSTAGRAM", "FACEBOOK", "EMAIL" ] }, "subscriptionState": { "type": "string", "description": "Subscription state", "example": "UNSUBSCRIBED", "enum": [ "SUBSCRIBED", "UNSUBSCRIBED" ] } }, "description": "Contact channel data" } }, "lists": { "type": "array", "description": "Contact lists", "items": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "List id in UUID format", "format": "uuid", "example": "025e93d3-051b-43f9-b12e-4b5842228dee" } }, "description": "Contact list create payload" } }, "description": "Contact data" } + Response 400 (application/json) Request has incorrect values + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "validation", "title": "string", "detail": "string", "invalidFields": [ { "name": "string", "channelType": "PHONE", "code": "must_not_be_empty", "reason": "string", "invalidIds": [ "string" ] } ] } + Schema { "required": [ "detail", "invalidFields", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" }, "invalidFields": { "type": "array", "description": "List of invalid fields", "items": { "$ref": "#/components/schemas/InvalidInputField" } } }, "description": "Invalid input error data" } + Response 401 No valid authentication details were provided + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unauthorized", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 403 The authenticated user or account doesn't have permission + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "forbidden", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 500 (application/json) Internal server error + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "internal_server_error", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 501 (application/json) Request not recognised + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "request_not_recognised", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 502 (application/json) Invalid server response + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "bad_gateway", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 503 (application/json) Server currently unavailable + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 504 (application/json) Gateway time out + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } ## Delete Contact [DELETE /api/v1/contacts/contacts/{contactIdToDelete}] Delete a contact that match with the indicated contact id. + Parameters + contactIdToDelete: `3fa85f64-5717-4562-b3fc-2c963f66afa6` (String, required) - The unique identifier for a contact in UUID format + Response 204 + Response 400 (application/json) Request has incorrect values + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "validation", "title": "string", "detail": "string", "invalidFields": [ { "name": "string", "channelType": "PHONE", "code": "must_not_be_empty", "reason": "string", "invalidIds": [ "string" ] } ] } + Schema { "required": [ "detail", "invalidFields", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" }, "invalidFields": { "type": "array", "description": "List of invalid fields", "items": { "$ref": "#/components/schemas/InvalidInputField" } } }, "description": "Invalid input error data" } + Response 401 No valid authentication details were provided + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unauthorized", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 403 The authenticated user or account doesn't have permission + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "forbidden", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 500 (application/json) Internal server error + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "internal_server_error", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 501 (application/json) Request not recognised + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "request_not_recognised", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 502 (application/json) Invalid server response + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "bad_gateway", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 503 (application/json) Server currently unavailable + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 504 (application/json) Gateway time out + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } ## Update Contact [PATCH /api/v1/contacts/contacts/{contactIdToUpdate}] Modify the contact linked to the specified contact ID. Only the fields included in the payload will be updated; all others will remain unchanged. The contact must have at least one communication channel. + Parameters + contactIdToUpdate: `3fa85f64-5717-4562-b3fc-2c963f66afa6` (String, required) - The unique identifier for a contact in UUID format + Request (application/json) + Body { "firstName": "Adam", "lastName": "Smith", "alias": "user1234", "dateOfBirth": "2022-08-18", "country": "US", "state": "CA", "location": "Sunset Blvd", "note": "Note", "channels": [ { "channelId": "+15553456783", "type": "SMS", "subscriptionState": "UNSUBSCRIBED" } ], "lists": [ { "id": "025e93d3-051b-43f9-b12e-4b5842228dee" } ], "customFields": [ { "id": "025e93d3-051b-43f9-b12e-4b5842228dee", "value": "John" } ] } + Schema { "type": "object", "properties": { "firstName": { "type": "string", "description": "Contact first name", "example": "Adam" }, "lastName": { "type": "string", "description": "Contact last name", "example": "Smith" }, "alias": { "type": "string", "description": "Contact alias. Used as an alternative name for your contact, as well as an email handle for email to sms", "example": "user1234" }, "dateOfBirth": { "type": "string", "description": "Date of birth", "format": "date", "example": "2022-08-18" }, "country": { "type": "string", "description": "Country", "example": "US" }, "state": { "type": "string", "description": "State", "example": "CA" }, "location": { "type": "string", "description": "Location", "example": "Sunset Blvd" }, "note": { "type": "string", "description": "Note", "example": "Note" }, "channels": { "type": "array", "description": "Contact channels", "items": { "required": [ "channelId", "type" ], "type": "object", "properties": { "channelId": { "type": "string", "description": "Contact channel id (in case phone number - in E164 international format)", "example": "+15553456783" }, "type": { "type": "string", "description": "Contact channel type", "example": "SMS", "enum": [ "SMS", "WHATSAPP" ] }, "subscriptionState": { "type": "string", "description": "Subscription state", "example": "UNSUBSCRIBED", "enum": [ "SUBSCRIBED", "UNSUBSCRIBED" ] } }, "description": "Contact channel update payload" } }, "lists": { "type": "array", "description": "Contact lists", "items": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "List id in UUID format", "format": "uuid", "example": "025e93d3-051b-43f9-b12e-4b5842228dee" } }, "description": "Contact list create payload" } }, "customFields": { "type": "array", "description": "Contact custom fields", "items": { "required": [ "id", "value" ], "type": "object", "properties": { "id": { "type": "string", "description": "Custom Field id in UUID format", "format": "uuid", "example": "025e93d3-051b-43f9-b12e-4b5842228dee" }, "value": { "type": "string", "description": "Custom field value", "example": "John" } }, "description": "Contact custom field update payload" } } }, "description": "Contact update payload" } + Response 200 (application/json) Contact updated + Body { "id": "025e93d3-051b-43f9-b12e-4b5842228dee", "accountId": "string", "vendorId": "string", "firstName": "Adam", "lastName": "Smith", "fullName": "Adam Smith", "alias": "VIP contact", "dateOfBirth": "2022-08-18", "country": "US", "state": "CA", "location": "Sunset Blvd", "note": "Note", "createdDate": "2022-08-18T09:15:03.112Z", "lastModifiedDate": "2022-08-18T09:15:03.112Z", "customFields": [ { "id": "025e93d3-051b-43f9-b12e-4b5842228dee", "mergeTag": "contact_name", "value": "John", "type": "DATE" } ], "channels": [ { "channelId": "+15553456783", "type": "SMS", "subscriptionState": "UNSUBSCRIBED" } ], "lists": [ { "id": "025e93d3-051b-43f9-b12e-4b5842228dee", "name": "My list" } ] } + Schema { "required": [ "accountId", "alias", "channels", "country", "createdDate", "customFields", "firstName", "fullName", "id", "lastModifiedDate", "lastName", "lists", "location", "note", "state", "vendorId" ], "type": "object", "properties": { "id": { "type": "string", "description": "Contact id in UUID format", "format": "uuid", "example": "025e93d3-051b-43f9-b12e-4b5842228dee" }, "accountId": { "type": "string", "description": "Account id" }, "vendorId": { "type": "string", "description": "Vendor id" }, "firstName": { "type": "string", "description": "Contact first name", "example": "Adam" }, "lastName": { "type": "string", "description": "Contact last name", "example": "Smith" }, "fullName": { "type": "string", "description": "Contact full name", "example": "Adam Smith" }, "alias": { "type": "string", "description": "Contact alias", "example": "VIP contact" }, "dateOfBirth": { "type": "string", "description": "Date of birth", "format": "date", "example": "2022-08-18" }, "country": { "type": "string", "description": "Country", "example": "US" }, "state": { "type": "string", "description": "State", "example": "CA" }, "location": { "type": "string", "description": "Location", "example": "Sunset Blvd" }, "note": { "type": "string", "description": "Note", "example": "Note" }, "createdDate": { "type": "string", "description": "Create date", "format": "date-time", "example": "2022-08-18T09:15:03.112Z" }, "lastModifiedDate": { "type": "string", "description": "Last modified date", "format": "date-time", "example": "2022-08-18T09:15:03.112Z" }, "customFields": { "type": "array", "description": "List of custom fields", "items": { "$ref": { "required": [ "id", "mergeTag", "type", "value" ], "type": "object", "properties": { "id": { "type": "string", "description": "Custom Field id in UUID format", "format": "uuid", "example": "025e93d3-051b-43f9-b12e-4b5842228dee" }, "mergeTag": { "type": "string", "description": "Custom field merge tag", "example": "contact_name" }, "value": { "type": "string", "description": "Custom field value", "example": "John" }, "type": { "type": "string", "description": "Custom field type", "example": "DATE", "enum": [ "DATE", "NUMBER", "PHONE", "TEXT", "URL", "ZIP_CODE", "NAME", "EMAIL" ] } }, "description": "Custom field data" } } }, "channels": { "type": "array", "description": "Contact channels", "items": { "required": [ "channelId", "type" ], "type": "object", "properties": { "channelId": { "type": "string", "description": "Contact channel id (in case phone number - in E164 international format)", "example": "+15553456783" }, "type": { "type": "string", "description": "Contact channel type", "example": "SMS", "enum": [ "SMS", "WHATSAPP", "GBM", "INSTAGRAM", "FACEBOOK", "EMAIL" ] }, "subscriptionState": { "type": "string", "description": "Subscription state", "example": "UNSUBSCRIBED", "enum": [ "SUBSCRIBED", "UNSUBSCRIBED" ] } }, "description": "Contact channel data" } }, "lists": { "type": "array", "description": "Contact lists", "items": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "List id in UUID format", "format": "uuid", "example": "025e93d3-051b-43f9-b12e-4b5842228dee" }, "name": { "type": "string", "description": "List name", "example": "My list" } }, "description": "Contact list data" } } }, "description": "Contact data" } + Response 400 (application/json) Request has incorrect values + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "validation", "title": "string", "detail": "string", "invalidFields": [ { "name": "string", "channelType": "PHONE", "code": "must_not_be_empty", "reason": "string", "invalidIds": [ "string" ] } ] } + Schema { "required": [ "detail", "invalidFields", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" }, "invalidFields": { "type": "array", "description": "List of invalid fields", "items": { "$ref": "#/components/schemas/InvalidInputField" } } }, "description": "Invalid input error data" } + Response 401 No valid authentication details were provided + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unauthorized", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 403 The authenticated user or account doesn't have permission + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "forbidden", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 409 (application/json) Conflict. The contact already exists. + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "conflict", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 500 (application/json) Internal server error + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "internal_server_error", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 501 (application/json) Request not recognised + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "request_not_recognised", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 502 (application/json) Invalid server response + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "bad_gateway", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 503 (application/json) Server currently unavailable + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 504 (application/json) Gateway time out + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } ## Retrieve Contacts [GET /api/v1/contacts/contacts{?nextPageToken,prevPageToken,pageSize,listIds,contactIds,channelIds,channelTypes,channelSubscriptionState}] Retrieve contacts based on the filter. If there is no filter, then it will return the next page sorted by creationDate + Parameters + nextPageToken: abc123 (string, optional) - Token to retrieve the next page of results. + prevPageToken: xyz456 (string, optional) - Token to retrieve the previous page of results. + pageSize: 1000 (integer, optional) - Number of results per page. Defaults to 1000. + listIds: `3fa85f64-5717-4562-b3fc-2c963f66afa6` (array[string], optional) - Filter results by specific list IDs. + contactIds: `3fa85f64-5717-4562-b3fc-2c963f66afa6` (array[string], optional) - Filter results by specific contact IDs. + channelIds: `+15556667777` (array[string], optional) - Filter results by specific channel IDs. + channelTypes: `PHONE,SMS` (array[string], optional) - Filter results by channel types. + Enum: `PHONE`, `SMS`, `EMAIL` + channelSubscriptionState: SUBSCRIBED (string, optional) - Filter results by subscription state. + Enum: `SUBSCRIBED`, `UNSUBSCRIBED` + Response 200 (application/json) Returns a contacts page + Body { "content": [ { "id": "025e93d3-051b-43f9-b12e-4b5842228dee", "accountId": "string", "vendorId": "string", "firstName": "Adam", "lastName": "Smith", "fullName": "Adam Smith", "alias": "VIP contact", "dateOfBirth": "2022-08-18", "country": "US", "state": "CA", "location": "Sunset Blvd", "note": "Note", "createdDate": "2022-08-18T09:15:03.112Z", "lastModifiedDate": "2022-08-18T09:15:03.112Z", "customFields": [ { "id": "025e93d3-051b-43f9-b12e-4b5842228dee", "mergeTag": "contact_name", "value": "John", "type": "DATE" } ], "channels": [ { "channelId": "+15553456783", "type": "SMS", "subscriptionState": "UNSUBSCRIBED" } ], "lists": [ { "id": "025e93d3-051b-43f9-b12e-4b5842228dee", "name": "My list" } ] } ], "nextPageToken": "string", "prevPageToken": "string", "totalElements": 25 } + Schema { "required": [ "content", "totalElements" ], "type": "object", "properties": { "content": { "type": "array", "description": "Page content and number of elements is restricted by page size", "items": { "required": [ "accountId", "alias", "channels", "country", "createdDate", "customFields", "firstName", "fullName", "id", "lastModifiedDate", "lastName", "lists", "location", "note", "state", "vendorId" ], "type": "object", "properties": { "id": { "type": "string", "description": "Contact id in UUID format", "format": "uuid", "example": "025e93d3-051b-43f9-b12e-4b5842228dee" }, "accountId": { "type": "string", "description": "Account id" }, "vendorId": { "type": "string", "description": "Vendor id" }, "firstName": { "type": "string", "description": "Contact first name", "example": "Adam" }, "lastName": { "type": "string", "description": "Contact last name", "example": "Smith" }, "fullName": { "type": "string", "description": "Contact full name", "example": "Adam Smith" }, "alias": { "type": "string", "description": "Contact alias", "example": "VIP contact" }, "dateOfBirth": { "type": "string", "description": "Date of birth", "format": "date", "example": "2022-08-18" }, "country": { "type": "string", "description": "Country", "example": "US" }, "state": { "type": "string", "description": "State", "example": "CA" }, "location": { "type": "string", "description": "Location", "example": "Sunset Blvd" }, "note": { "type": "string", "description": "Note", "example": "Note" }, "createdDate": { "type": "string", "description": "Create date", "format": "date-time", "example": "2022-08-18T09:15:03.112Z" }, "lastModifiedDate": { "type": "string", "description": "Last modified date", "format": "date-time", "example": "2022-08-18T09:15:03.112Z" }, "customFields": { "type": "array", "description": "List of custom fields", "items": { "$ref": { "required": [ "id", "mergeTag", "type", "value" ], "type": "object", "properties": { "id": { "type": "string", "description": "Custom Field id in UUID format", "format": "uuid", "example": "025e93d3-051b-43f9-b12e-4b5842228dee" }, "mergeTag": { "type": "string", "description": "Custom field merge tag", "example": "contact_name" }, "value": { "type": "string", "description": "Custom field value", "example": "John" }, "type": { "type": "string", "description": "Custom field type", "example": "DATE", "enum": [ "DATE", "NUMBER", "PHONE", "TEXT", "URL", "ZIP_CODE", "NAME", "EMAIL" ] } }, "description": "Custom field data" } } }, "channels": { "type": "array", "description": "Contact channels", "items": { "required": [ "channelId", "type" ], "type": "object", "properties": { "channelId": { "type": "string", "description": "Contact channel id (in case phone number - in E164 international format)", "example": "+15553456783" }, "type": { "type": "string", "description": "Contact channel type", "example": "SMS", "enum": [ "SMS", "WHATSAPP", "GBM", "INSTAGRAM", "FACEBOOK", "EMAIL" ] }, "subscriptionState": { "type": "string", "description": "Subscription state", "example": "UNSUBSCRIBED", "enum": [ "SUBSCRIBED", "UNSUBSCRIBED" ] } }, "description": "Contact channel data" } }, "lists": { "type": "array", "description": "Contact lists", "items": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "List id in UUID format", "format": "uuid", "example": "025e93d3-051b-43f9-b12e-4b5842228dee" }, "name": { "type": "string", "description": "List name", "example": "My list" } }, "description": "Contact list data" } } }, "description": "Contact data" } }, "nextPageToken": { "type": "string", "description": "Pagination token to retrieve the next page" }, "prevPageToken": { "type": "string", "description": "Pagination token to retrieve the previous page" }, "totalElements": { "type": "integer", "description": "Total number of elements", "format": "int64", "example": 25 } }, "description": "Page token representation for search result" } + Response 400 (application/json) Request has incorrect values + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "validation", "title": "string", "detail": "string", "invalidFields": [ { "name": "string", "channelType": "PHONE", "code": "must_not_be_empty", "reason": "string", "invalidIds": [ "string" ] } ] } + Schema { "required": [ "detail", "invalidFields", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" }, "invalidFields": { "type": "array", "description": "List of invalid fields", "items": { "$ref": "#/components/schemas/InvalidInputField" } } }, "description": "Invalid input error data" } + Response 401 No valid authentication details were provided + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unauthorized", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 403 The authenticated user or account doesn't have permission + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "forbidden", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 500 (application/json) Internal server error + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "internal_server_error", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 501 (application/json) Request not recognised + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "request_not_recognised", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 502 (application/json) Invalid server response + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "bad_gateway", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 503 (application/json) Server currently unavailable + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 504 (application/json) Gateway time out + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } # Lists [/api/v1/contacts/lists] ## Create List [POST /api/v1/contacts/lists] Create a new contact list. + Request (application/json) + Body { "name": "My group", "alias": "Group1" } + Schema { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Group name", "example": "My group" }, "alias": { "type": "string", "description": "Group alias", "example": "Group1" } }, "description": "Contact list create payload" } + Response 201 (application/json) Contact succesfully created + Body { "id": "025e93d3-051b-43f9-b12e-4b5842228dee", "accountId": "string", "vendorId": "string", "name": "My group", "alias": "VIP group", "createdDate": "2022-08-18T09:15:03.112Z", "lastModifiedDate": "2022-08-18T09:15:03.112Z" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 400 (application/json) Request has incorrect values + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "validation", "title": "string", "detail": "string", "invalidFields": [ { "name": "string", "channelType": "PHONE", "code": "must_not_be_empty", "reason": "string", "invalidIds": [ "string" ] } ] } + Schema { "required": [ "detail", "invalidFields", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" }, "invalidFields": { "type": "array", "description": "List of invalid fields", "items": { "$ref": "#/components/schemas/InvalidInputField" } } }, "description": "Invalid input error data" } + Response 401 No valid authentication details were provided + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unauthorized", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 403 The authenticated user or account doesn't have permission + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "forbidden", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 409 (application/json) Conflict. The list already exists. + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "conflict", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 500 (application/json) Internal server error + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "internal_server_error", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 501 (application/json) Request not recognised + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "request_not_recognised", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 502 (application/json) Invalid server response + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "bad_gateway", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 503 (application/json) Server currently unavailable + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 504 (application/json) Gateway time out + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } ## Get List [GET /api/v1/contacts/lists/{listId}] Retrieve a list. + Parameters + listId: `3fa85f64-5717-4562-b3fc-2c963f66afa6` (String, required) - The unique identifier for a list in UUID format + Response 200 (application/json) List requested data + Body { "id": "025e93d3-051b-43f9-b12e-4b5842228dee", "accountId": "string", "vendorId": "string", "name": "My group", "alias": "VIP group", "createdDate": "2022-08-18T09:15:03.112Z", "lastModifiedDate": "2022-08-18T09:15:03.112Z" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 400 (application/json) Request has incorrect values + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "validation", "title": "string", "detail": "string", "invalidFields": [ { "name": "string", "channelType": "PHONE", "code": "must_not_be_empty", "reason": "string", "invalidIds": [ "string" ] } ] } + Schema { "required": [ "detail", "invalidFields", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" }, "invalidFields": { "type": "array", "description": "List of invalid fields", "items": { "$ref": "#/components/schemas/InvalidInputField" } } }, "description": "Invalid input error data" } + Response 401 No valid authentication details were provided + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unauthorized", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 403 The authenticated user or account doesn't have permission + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "forbidden", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 500 (application/json) Internal server error + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "internal_server_error", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 501 (application/json) Request not recognised + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "request_not_recognised", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 502 (application/json) Invalid server response + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "bad_gateway", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 503 (application/json) Server currently unavailable + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 504 (application/json) Gateway time out + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } ## Delete List [DELETE /api/v1/contacts/lists/{listIdToRemove}] Delete a list that matches with the indicated listId. + Parameters + listIdToRemove: `3fa85f64-5717-4562-b3fc-2c963f66afa6` (String, required) - The unique identifier for a list in UUID format + Response 204 + Response 400 (application/json) Request has incorrect values + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "validation", "title": "string", "detail": "string", "invalidFields": [ { "name": "string", "channelType": "PHONE", "code": "must_not_be_empty", "reason": "string", "invalidIds": [ "string" ] } ] } + Schema { "required": [ "detail", "invalidFields", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" }, "invalidFields": { "type": "array", "description": "List of invalid fields", "items": { "$ref": "#/components/schemas/InvalidInputField" } } }, "description": "Invalid input error data" } + Response 401 No valid authentication details were provided + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unauthorized", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 403 The authenticated user or account doesn't have permission + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "forbidden", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 500 (application/json) Internal server error + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "internal_server_error", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 501 (application/json) Request not recognised + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "request_not_recognised", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 502 (application/json) Invalid server response + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "bad_gateway", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 503 (application/json) Server currently unavailable + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 504 (application/json) Gateway time out + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } ## Update List [PATCH /api/v1/contacts/lists/{listIdToUpdate}] Modify the list linked to the specified list ID. Only the fields included in the payload will be updated; all others will remain unchanged. + Parameters + listIdToUpdate: `3fa85f64-5717-4562-b3fc-2c963f66afa6` (String, required) - The unique identifier for a list in UUID format + Request (application/json) + Body { "name": "My list", "alias": "List1" } + Schema { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string", "description": "Contact list name", "example": "My list" }, "alias": { "type": "string", "description": "Contact list alias", "example": "List1" }, "nameSet": { "type": "boolean", "writeOnly": true }, "aliasSet": { "type": "boolean", "writeOnly": true } }, "description": "Contact list update payload" } + Response 200 (application/json) Contact updated + Body { "id": "025e93d3-051b-43f9-b12e-4b5842228dee", "accountId": "AccountA", "vendorId": "VendorB", "name": "My group", "alias": "VIP group", "createdDate": "2022-08-18T09:15:03.112Z", "lastModifiedDate": "2022-08-18T09:15:03.112Z" } + Schema { "required": [ "accountId", "alias", "createdDate", "id", "lastModifiedDate", "name", "vendorId" ], "type": "object", "properties": { "id": { "type": "string", "description": "List id in UUID format", "format": "uuid", "example": "025e93d3-051b-43f9-b12e-4b5842228dee" }, "accountId": { "type": "string", "description": "Account id" }, "vendorId": { "type": "string", "description": "Vendor id" }, "name": { "type": "string", "description": "List name", "example": "My group" }, "alias": { "type": "string", "description": "List alias", "example": "VIP group" }, "createdDate": { "type": "string", "description": "Create date", "format": "date-time", "example": "2022-08-18T09:15:03.112Z" }, "lastModifiedDate": { "type": "string", "description": "Last modified date", "format": "date-time", "example": "2022-08-18T09:15:03.112Z" } }, "description": "List details data" } + Response 400 (application/json) Request has incorrect values + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "validation", "title": "string", "detail": "string", "invalidFields": [ { "name": "string", "channelType": "PHONE", "code": "must_not_be_empty", "reason": "string", "invalidIds": [ "string" ] } ] } + Schema { "required": [ "detail", "invalidFields", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" }, "invalidFields": { "type": "array", "description": "List of invalid fields", "items": { "$ref": "#/components/schemas/InvalidInputField" } } }, "description": "Invalid input error data" } + Response 401 No valid authentication details were provided + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unauthorized", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 403 The authenticated user or account doesn't have permission + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "forbidden", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 409 (application/json) Conflict. The list already exists. + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "conflict", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 500 (application/json) Internal server error + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "internal_server_error", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 501 (application/json) Request not recognised + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "request_not_recognised", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 502 (application/json) Invalid server response + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "bad_gateway", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 503 (application/json) Server currently unavailable + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 504 (application/json) Gateway time out + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } ## Add Contact to List [POST /api/v1/contacts/lists/{listId}/contacts/{contactToAdd}] Add indicated contact to list. + Parameters + listId: `3fa85f64-5717-4562-b3fc-2c963f66afa6` (String, required) - The unique identifier for a list in UUID format + contactToAdd: `3fa85f64-5717-4562-b3fc-2c963f66afa6` (String, required) - The unique identifier for a contact in UUID format + Response 200 (application/json) Contacts added to the list + Body { "id": "025e93d3-051b-43f9-b12e-4b5842228dee", "accountId": "string", "vendorId": "string", "name": "My group", "alias": "VIP group", "createdDate": "2022-08-18T09:15:03.112Z", "lastModifiedDate": "2022-08-18T09:15:03.112Z" } + Schema { "required": [ "accountId", "alias", "createdDate", "id", "lastModifiedDate", "name", "vendorId" ], "type": "object", "properties": { "id": { "type": "string", "description": "List id in UUID format", "format": "uuid", "example": "025e93d3-051b-43f9-b12e-4b5842228dee" }, "accountId": { "type": "string", "description": "Account id" }, "vendorId": { "type": "string", "description": "Vendor id" }, "name": { "type": "string", "description": "List name", "example": "My group" }, "alias": { "type": "string", "description": "List alias", "example": "VIP group" }, "createdDate": { "type": "string", "description": "Create date", "format": "date-time", "example": "2022-08-18T09:15:03.112Z" }, "lastModifiedDate": { "type": "string", "description": "Last modified date", "format": "date-time", "example": "2022-08-18T09:15:03.112Z" } }, "description": "List details data" } + Response 400 (application/json) Request has incorrect values + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "validation", "title": "string", "detail": "string", "invalidFields": [ { "name": "string", "channelType": "PHONE", "code": "must_not_be_empty", "reason": "string", "invalidIds": [ "string" ] } ] } + Schema { "required": [ "detail", "invalidFields", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" }, "invalidFields": { "type": "array", "description": "List of invalid fields", "items": { "$ref": "#/components/schemas/InvalidInputField" } } }, "description": "Invalid input error data" } + Response 401 No valid authentication details were provided + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unauthorized", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 403 The authenticated user or account doesn't have permission + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "forbidden", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 500 (application/json) Internal server error + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "internal_server_error", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 501 (application/json) Request not recognised + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "request_not_recognised", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 502 (application/json) Invalid server response + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "bad_gateway", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 503 (application/json) Server currently unavailable + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 504 (application/json) Gateway time out + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } ## Remove Contact from List [DELETE /api/v1/contacts/lists/{listId}/contacts/{contactId}] One single contact will be removed from the indicated list. + Parameters + listId: `3fa85f64-5717-4562-b3fc-2c963f66afa6` (String, required) - The unique identifier for a list in UUID format + contactId: `3fa85f64-5717-4562-b3fc-2c963f66afa6` (String, required) - The unique identifier for a contact in UUID format + Response 204 + Response 400 (application/json) Request has incorrect values + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "validation", "title": "string", "detail": "string", "invalidFields": [ { "name": "string", "channelType": "PHONE", "code": "must_not_be_empty", "reason": "string", "invalidIds": [ "string" ] } ] } + Schema { "required": [ "detail", "invalidFields", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" }, "invalidFields": { "type": "array", "description": "List of invalid fields", "items": { "$ref": "#/components/schemas/InvalidInputField" } } }, "description": "Invalid input error data" } + Response 401 No valid authentication details were provided + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unauthorized", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 403 The authenticated user or account doesn't have permission + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "forbidden", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 500 (application/json) Internal server error + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "internal_server_error", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 501 (application/json) Request not recognised + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "request_not_recognised", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 502 (application/json) Invalid server response + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "bad_gateway", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 503 (application/json) Server currently unavailable + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 504 (application/json) Gateway time out + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } ## Add or remove multiple contacts to/from a List [PATCH /api/v1/contacts/lists/{listId}/contacts] Add/Remove indicated contacts to list. + Parameters + listId: `3fa85f64-5717-4562-b3fc-2c963f66afa6` (String, required) - The unique identifier for a list in UUID format + Request (application/json) + Body { "contactsToAddIds": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "contactsToRemoveIds": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] } + Schema { "type": "object", "properties": { "contactsToAddIds": { "maxItems": 1000, "type": "array", "items": { "type": "string", "description": "List of contacts to add to the list in UUID format", "format": "uuid" } }, "contactsToRemoveIds": { "maxItems": 1000, "type": "array", "items": { "type": "string", "description": "List of contacts to remove to the list in UUID format", "format": "uuid" } } }, "description": "Contacts list update payload" } + Response 200 (application/json) Contacts list updated correctly + Body { "id": "025e93d3-051b-43f9-b12e-4b5842228dee", "accountId": "string", "vendorId": "string", "name": "My group", "alias": "VIP group", "createdDate": "2022-08-18T09:15:03.112Z", "lastModifiedDate": "2022-08-18T09:15:03.112Z" } + Schema { "required": [ "accountId", "alias", "createdDate", "id", "lastModifiedDate", "name", "vendorId" ], "type": "object", "properties": { "id": { "type": "string", "description": "List id in UUID format", "format": "uuid", "example": "025e93d3-051b-43f9-b12e-4b5842228dee" }, "accountId": { "type": "string", "description": "Account id" }, "vendorId": { "type": "string", "description": "Vendor id" }, "name": { "type": "string", "description": "List name", "example": "My group" }, "alias": { "type": "string", "description": "List alias", "example": "VIP group" }, "createdDate": { "type": "string", "description": "Create date", "format": "date-time", "example": "2022-08-18T09:15:03.112Z" }, "lastModifiedDate": { "type": "string", "description": "Last modified date", "format": "date-time", "example": "2022-08-18T09:15:03.112Z" } }, "description": "List details data" } + Response 400 (application/json) Request has incorrect values + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "validation", "title": "string", "detail": "string", "invalidFields": [ { "name": "string", "channelType": "PHONE", "code": "must_not_be_empty", "reason": "string", "invalidIds": [ "string" ] } ] } + Schema { "required": [ "detail", "invalidFields", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" }, "invalidFields": { "type": "array", "description": "List of invalid fields", "items": { "$ref": "#/components/schemas/InvalidInputField" } } }, "description": "Invalid input error data" } + Response 401 No valid authentication details were provided + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unauthorized", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 403 The authenticated user or account doesn't have permission + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "forbidden", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 500 (application/json) Internal server error + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "internal_server_error", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 501 (application/json) Request not recognised + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "request_not_recognised", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 502 (application/json) Invalid server response + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "bad_gateway", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 503 (application/json) Server currently unavailable + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 504 (application/json) Gateway time out + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } ## Retrieve Lists [GET /api/v1/contacts/lists{?nextPageToken,prevPageToken,pageSize,listIds,alias,name}] Retrieve lists based on the filter. If there is no filter, then it will return the next page sorted by creationDate + Parameters + nextPageToken: abc123 (string, optional) - Token to retrieve the next page of results. + prevPageToken: xyz456 (string, optional) - Token to retrieve the previous page of results. + pageSize: 1000 (integer, optional) - Number of results per page. Defaults to 1000. + listIds: `3fa85f64-5717-4562-b3fc-2c963f66afa6` (array[string], optional) - Filter results by specific list IDs. + alias: listAlias (string, optional) - Filter results by list alias. + name: listName (string, optional) - Filter results by list name. + Response 200 (application/json) Returns a lists page + Body { "content": [ { "id": "025e93d3-051b-43f9-b12e-4b5842228dee", "accountId": "string", "vendorId": "string", "name": "My group", "alias": "VIP group", "createdDate": "2022-08-18T09:15:03.112Z", "lastModifiedDate": "2022-08-18T09:15:03.112Z" } ], "nextPageToken": "string", "prevPageToken": "string", "totalElements": 25 } + Schema { "required": [ "content", "totalElements" ], "type": "object", "properties": { "content": { "type": "array", "description": "Page content and number of elements is restricted by page size", "items": { "required": [ "accountId", "alias", "createdDate", "id", "lastModifiedDate", "name", "vendorId" ], "type": "object", "properties": { "id": { "type": "string", "description": "List id in UUID format", "format": "uuid", "example": "025e93d3-051b-43f9-b12e-4b5842228dee" }, "accountId": { "type": "string", "description": "Account id" }, "vendorId": { "type": "string", "description": "Vendor id" }, "name": { "type": "string", "description": "List name", "example": "My group" }, "alias": { "type": "string", "description": "List alias", "example": "VIP group" }, "createdDate": { "type": "string", "description": "Create date", "format": "date-time", "example": "2022-08-18T09:15:03.112Z" }, "lastModifiedDate": { "type": "string", "description": "Last modified date", "format": "date-time", "example": "2022-08-18T09:15:03.112Z" } }, "description": "List details data" } }, "nextPageToken": { "type": "string", "description": "Pagination token to retrieve the next page" }, "prevPageToken": { "type": "string", "description": "Pagination token to retrieve the previous page" }, "totalElements": { "type": "integer", "description": "Total number of elements", "format": "int64", "example": 25 } }, "description": "Page token representation for search result" } + Response 400 (application/json) Request has incorrect values + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "validation", "title": "string", "detail": "string", "invalidFields": [ { "name": "string", "channelType": "PHONE", "code": "must_not_be_empty", "reason": "string", "invalidIds": [ "string" ] } ] } + Schema { "required": [ "detail", "invalidFields", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" }, "invalidFields": { "type": "array", "description": "List of invalid fields", "items": { "$ref": "#/components/schemas/InvalidInputField" } } }, "description": "Invalid input error data" } + Response 401 No valid authentication details were provided + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unauthorized", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 403 The authenticated user or account doesn't have permission + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "forbidden", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 500 (application/json) Internal server error + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "internal_server_error", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 501 (application/json) Request not recognised + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "request_not_recognised", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 502 (application/json) Invalid server response + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "bad_gateway", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 503 (application/json) Server currently unavailable + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 504 (application/json) Gateway time out + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } #CustomFields [/api/v1/contacts/custom-fields] ## Create CustomField [POST /api/v1/contacts/custom-fields] Create a new custom field, which will be linked to the account. This custom field can have a value assigned to it for all contacts within the account. + Request (application/json) + Body { "label": "Pet name", "mergeTag": "pet_name", "maxLength": 30, "type": "TEXT" } + Schema { "required": [ "label", "maxLength", "mergeTag", "type" ], "type": "object", "properties": { "label": { "type": "string", "description": "Custom field label", "example": "Contact name" }, "mergeTag": { "type": "string", "description": "Custom field merge tag", "example": "contact_name" }, "maxLength": { "type": "integer", "description": "Custom field max length", "format": "int32", "example": 30 }, "type": { "type": "string", "description": "Custom field type", "example": "DATE", "enum": [ "DATE", "NUMBER", "PHONE", "TEXT", "URL", "ZIP_CODE", "NAME", "EMAIL" ] } }, "description": "Custom field create payload" } + Response 201 (application/json) Contact succesfully created + Body { "id": "025e93d3-051b-43f9-b12e-4b5842228dee", "accountId": "string", "vendorId": "string", "firstName": "Adam", "lastName": "Smith", "fullName": "Adam Smith", "alias": "VIP contact", "dateOfBirth": "2022-08-18", "country": "US", "state": "CA", "location": "Sunset Blvd", "note": "Note", "createdDate": "2022-08-18T09:15:03.112Z", "lastModifiedDate": "2022-08-18T09:15:03.112Z", "customFields": [ { "id": "025e93d3-051b-43f9-b12e-4b5842228dee", "mergeTag": "contact_name", "value": "John", "type": "DATE" } ], "channels": [ { "channelId": "+15553456783", "type": "SMS", "subscriptionState": "UNSUBSCRIBED" } ], "lists": [ { "id": "025e93d3-051b-43f9-b12e-4b5842228dee", "name": "My list" } ] } + Schema { "required": [ "accountId", "alias", "channels", "country", "createdDate", "customFields", "firstName", "fullName", "id", "lastModifiedDate", "lastName", "lists", "location", "note", "state", "vendorId" ], "type": "object", "properties": { "id": { "type": "string", "description": "Contact id in UUID format", "format": "uuid", "example": "025e93d3-051b-43f9-b12e-4b5842228dee" }, "accountId": { "type": "string", "description": "Account id" }, "vendorId": { "type": "string", "description": "Vendor id" }, "firstName": { "type": "string", "description": "Contact first name", "example": "Adam" }, "lastName": { "type": "string", "description": "Contact last name", "example": "Smith" }, "fullName": { "type": "string", "description": "Contact full name", "example": "Adam Smith" }, "alias": { "type": "string", "description": "Contact alias", "example": "VIP contact" }, "dateOfBirth": { "type": "string", "description": "Date of birth", "format": "date", "example": "2022-08-18" }, "country": { "type": "string", "description": "Country", "example": "US" }, "state": { "type": "string", "description": "State", "example": "CA" }, "location": { "type": "string", "description": "Location", "example": "Sunset Blvd" }, "note": { "type": "string", "description": "Note", "example": "Note" }, "createdDate": { "type": "string", "description": "Create date", "format": "date-time", "example": "2022-08-18T09:15:03.112Z" }, "lastModifiedDate": { "type": "string", "description": "Last modified date", "format": "date-time", "example": "2022-08-18T09:15:03.112Z" }, "customFields": { "type": "array", "description": "List of custom fields", "items": { "$ref": { "required": [ "id", "mergeTag", "type", "value" ], "type": "object", "properties": { "id": { "type": "string", "description": "Custom Field id in UUID format", "format": "uuid", "example": "025e93d3-051b-43f9-b12e-4b5842228dee" }, "mergeTag": { "type": "string", "description": "Custom field merge tag", "example": "contact_name" }, "value": { "type": "string", "description": "Custom field value", "example": "John" }, "type": { "type": "string", "description": "Custom field type", "example": "DATE", "enum": [ "DATE", "NUMBER", "PHONE", "TEXT", "URL", "ZIP_CODE", "NAME", "EMAIL" ] } }, "description": "Custom field data" } } }, "channels": { "type": "array", "description": "Contact channels", "items": { "required": [ "channelId", "type" ], "type": "object", "properties": { "channelId": { "type": "string", "description": "Contact channel id (in case phone number - in E164 international format)", "example": "+15553456783" }, "type": { "type": "string", "description": "Contact channel type", "example": "SMS", "enum": [ "SMS", "WHATSAPP", "GBM", "INSTAGRAM", "FACEBOOK", "EMAIL" ] }, "subscriptionState": { "type": "string", "description": "Subscription state", "example": "UNSUBSCRIBED", "enum": [ "SUBSCRIBED", "UNSUBSCRIBED" ] } }, "description": "Contact channel data" } }, "lists": { "type": "array", "description": "Contact lists", "items": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "string", "description": "List id in UUID format", "format": "uuid", "example": "025e93d3-051b-43f9-b12e-4b5842228dee" }, "name": { "type": "string", "description": "List name", "example": "My list" } }, "description": "Contact list data" } } }, "description": "Contact data" } + Response 400 (application/json) Request has incorrect values + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "validation", "title": "string", "detail": "string", "invalidFields": [ { "name": "string", "channelType": "PHONE", "code": "must_not_be_empty", "reason": "string", "invalidIds": [ "string" ] } ] } + Schema { "required": [ "detail", "invalidFields", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" }, "invalidFields": { "type": "array", "description": "List of invalid fields", "items": { "$ref": "#/components/schemas/InvalidInputField" } } }, "description": "Invalid input error data" } + Response 401 No valid authentication details were provided + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unauthorized", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 403 The authenticated user or account doesn't have permission + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "forbidden", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 409 (application/json) Conflict. The contact already exists. + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "conflict", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 500 (application/json) Internal server error + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "internal_server_error", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 501 (application/json) Request not recognised + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "request_not_recognised", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 502 (application/json) Invalid server response + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "bad_gateway", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 503 (application/json) Server currently unavailable + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 504 (application/json) Gateway time out + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } ## Get CustomField [GET /api/v1/contacts/contacts/{customFieldId}] Retrieve a customField based on the customField id. + Parameters + customFieldId: `3fa85f64-5717-4562-b3fc-2c963f66afa6` (String, required) - The unique identifier for a customField in UUID format + Response 200 (application/json) Contact requested data + Body { "id": "025e93d3-051b-43f9-b12e-4b5842228dee", "accountId": "accountId_67846328", "vendorId": "string", "label": "Contact name", "mergeTag": "contact_name", "maxLength": 30, "type": "DATE", "createdDate": "2022-08-18T09:15:03.112Z", "lastModifiedDate": "2022-08-18T09:15:03.112Z" } + Schema { "required": [ "accountId", "createdDate", "id", "label", "lastModifiedDate", "maxLength", "mergeTag", "type", "vendorId" ], "type": "object", "properties": { "id": { "type": "string", "description": "Custom field id in UUID format", "format": "uuid", "example": "025e93d3-051b-43f9-b12e-4b5842228dee" }, "accountId": { "type": "string", "description": "Account id", "example": "accountId_67846328" }, "vendorId": { "type": "string", "description": "Vendor id" }, "label": { "type": "string", "description": "Custom field label", "example": "Contact name" }, "mergeTag": { "type": "string", "description": "Custom field merge tag", "example": "contact_name" }, "maxLength": { "type": "integer", "description": "Custom field max length", "format": "int32", "example": 30 }, "type": { "type": "string", "description": "Custom field type", "example": "DATE", "enum": [ "DATE", "NUMBER", "PHONE", "TEXT", "URL", "ZIP_CODE", "NAME", "EMAIL" ] }, "createdDate": { "type": "string", "description": "Create date", "format": "date-time", "example": "2022-08-18T09:15:03.112Z" }, "lastModifiedDate": { "type": "string", "description": "Last modified date", "format": "date-time", "example": "2022-08-18T09:15:03.112Z" } }, "description": "Custom field data" } + Response 400 (application/json) Request has incorrect values + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "validation", "title": "string", "detail": "string", "invalidFields": [ { "name": "string", "channelType": "PHONE", "code": "must_not_be_empty", "reason": "string", "invalidIds": [ "string" ] } ] } + Schema { "required": [ "detail", "invalidFields", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" }, "invalidFields": { "type": "array", "description": "List of invalid fields", "items": { "$ref": "#/components/schemas/InvalidInputField" } } }, "description": "Invalid input error data" } + Response 401 No valid authentication details were provided + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unauthorized", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 403 The authenticated user or account doesn't have permission + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "forbidden", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 500 (application/json) Internal server error + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "internal_server_error", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 501 (application/json) Request not recognised + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "request_not_recognised", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 502 (application/json) Invalid server response + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "bad_gateway", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 503 (application/json) Server currently unavailable + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 504 (application/json) Gateway time out + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } ## Delete CustomField [DELETE /api/v1/contacts/contacts/{customFieldIdToDelete}] Delete a customField that match with the indicated customField id. + Parameters + customFieldIdToDelete: `3fa85f64-5717-4562-b3fc-2c963f66afa6` (String, required) - The unique identifier for a customField in UUID format + Response 204 + Response 400 (application/json) Request has incorrect values + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "validation", "title": "string", "detail": "string", "invalidFields": [ { "name": "string", "channelType": "PHONE", "code": "must_not_be_empty", "reason": "string", "invalidIds": [ "string" ] } ] } + Schema { "required": [ "detail", "invalidFields", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" }, "invalidFields": { "type": "array", "description": "List of invalid fields", "items": { "$ref": "#/components/schemas/InvalidInputField" } } }, "description": "Invalid input error data" } + Response 401 No valid authentication details were provided + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unauthorized", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 403 The authenticated user or account doesn't have permission + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "forbidden", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 500 (application/json) Internal server error + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "internal_server_error", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 501 (application/json) Request not recognised + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "request_not_recognised", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 502 (application/json) Invalid server response + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "bad_gateway", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 503 (application/json) Server currently unavailable + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 504 (application/json) Gateway time out + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } ## Update CustomField [PATCH /api/v1/contacts/contacts/{customFieldIdToUpdate}] Modify the customField linked to the specified customField id. Only the fields included in the payload will be updated; all others will remain unchanged. Reducing the length of a custom field or changing its associated merge tag is not allowed. + Parameters + customFieldIdToUpdate: `3fa85f64-5717-4562-b3fc-2c963f66afa6` (String, required) - The unique identifier for a customField in UUID format + Request (application/json) + Body { "label": "Contact field new name", "maxLength": 50 } + Schema { "type": "object", "properties": { "label": { "type": "string", "description": "Custom field label", "example": "Contact name new name" }, "maxLength": { "type": "integer", "description": "Custom field max length", "format": "int32", "example": 50 } }, "description": "Custom field update payload" } + Response 200 (application/json) CustomField updated + Body { "id": "025e93d3-051b-43f9-b12e-4b5842228dee", "accountId": "accountId_67846328", "vendorId": "string", "label": "Contact field new name", "mergeTag": "contact_name", "maxLength": 50, "type": "DATE", "createdDate": "2022-08-18T09:15:03.112Z", "lastModifiedDate": "2022-08-18T09:15:03.112Z" } + Schema { "required": [ "accountId", "createdDate", "id", "label", "lastModifiedDate", "maxLength", "mergeTag", "type", "vendorId" ], "type": "object", "properties": { "id": { "type": "string", "description": "Custom field id in UUID format", "format": "uuid", "example": "025e93d3-051b-43f9-b12e-4b5842228dee" }, "accountId": { "type": "string", "description": "Account id", "example": "accountId_67846328" }, "vendorId": { "type": "string", "description": "Vendor id" }, "label": { "type": "string", "description": "Custom field label", "example": "Contact name" }, "mergeTag": { "type": "string", "description": "Custom field merge tag", "example": "contact_name" }, "maxLength": { "type": "integer", "description": "Custom field max length", "format": "int32", "example": 30 }, "type": { "type": "string", "description": "Custom field type", "example": "DATE", "enum": [ "DATE", "NUMBER", "PHONE", "TEXT", "URL", "ZIP_CODE", "NAME", "EMAIL" ] }, "createdDate": { "type": "string", "description": "Create date", "format": "date-time", "example": "2022-08-18T09:15:03.112Z" }, "lastModifiedDate": { "type": "string", "description": "Last modified date", "format": "date-time", "example": "2022-08-18T09:15:03.112Z" } }, "description": "Custom field data" } + Response 400 (application/json) Request has incorrect values + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "validation", "title": "string", "detail": "string", "invalidFields": [ { "name": "string", "channelType": "PHONE", "code": "must_not_be_empty", "reason": "string", "invalidIds": [ "string" ] } ] } + Schema { "required": [ "detail", "invalidFields", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" }, "invalidFields": { "type": "array", "description": "List of invalid fields", "items": { "$ref": "#/components/schemas/InvalidInputField" } } }, "description": "Invalid input error data" } + Response 401 No valid authentication details were provided + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unauthorized", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 403 The authenticated user or account doesn't have permission + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "forbidden", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 409 (application/json) Conflict. The CustomField already exists. + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "conflict", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 500 (application/json) Internal server error + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "internal_server_error", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 501 (application/json) Request not recognised + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "request_not_recognised", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 502 (application/json) Invalid server response + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "bad_gateway", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 503 (application/json) Server currently unavailable + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 504 (application/json) Gateway time out + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } ## Retrieve CustomFields [GET /api/v1/contacts/custom-fields{?nextPageToken,prevPageToken,pageSize,customFieldIds,label,mergeTag}] Retrieve customFields based on the filter. If there is no filter, then it will return the next page sorted by creationDate + Parameters + nextPageToken: abc123 (string, optional) - Token to retrieve the next page of results. + prevPageToken: xyz456 (string, optional) - Token to retrieve the previous page of results. + pageSize: 1000 (integer, optional) - Number of results per page. Defaults to 1000. + customFieldIds: `3fa85f64-5717-4562-b3fc-2c963f66afa6` (array[string], optional) - Filter results by specific customFields IDs. + label: label123 (string, optional) - Filter results by custom field label. + mergeTag: mergeTag345 (string, optional) - Filter results by custom field merge tag. + Response 200 (application/json) Returns a CustomField page + Body { "content": [ { "id": "025e93d3-051b-43f9-b12e-4b5842228dee", "accountId": "accountId_67846328", "vendorId": "string", "label": "Contact field new name", "mergeTag": "contact_name", "maxLength": 50, "type": "DATE", "createdDate": "2022-08-18T09:15:03.112Z", "lastModifiedDate": "2022-08-18T09:15:03.112Z" } ], "nextPageToken": "string", "prevPageToken": "string", "totalElements": 25 } + Schema { "required": [ "content", "totalElements" ], "type": "object", "properties": { "content": { "type": "array", "description": "Page content and number of elements is restricted by page size", "items": { "required": [ "accountId", "createdDate", "id", "label", "lastModifiedDate", "maxLength", "mergeTag", "type", "vendorId" ], "type": "object", "properties": { "id": { "type": "string", "description": "Custom field id in UUID format", "format": "uuid", "example": "025e93d3-051b-43f9-b12e-4b5842228dee" }, "accountId": { "type": "string", "description": "Account id", "example": "accountId_67846328" }, "vendorId": { "type": "string", "description": "Vendor id" }, "label": { "type": "string", "description": "Custom field label", "example": "Contact name" }, "mergeTag": { "type": "string", "description": "Custom field merge tag", "example": "contact_name" }, "maxLength": { "type": "integer", "description": "Custom field max length", "format": "int32", "example": 30 }, "type": { "type": "string", "description": "Custom field type", "example": "DATE", "enum": [ "DATE", "NUMBER", "PHONE", "TEXT", "URL", "ZIP_CODE", "NAME", "EMAIL" ] }, "createdDate": { "type": "string", "description": "Create date", "format": "date-time", "example": "2022-08-18T09:15:03.112Z" }, "lastModifiedDate": { "type": "string", "description": "Last modified date", "format": "date-time", "example": "2022-08-18T09:15:03.112Z" } }, "description": "Custom field data" }, "nextPageToken": { "type": "string", "description": "Pagination token to retrieve the next page" }, "prevPageToken": { "type": "string", "description": "Pagination token to retrieve the previous page" }, "totalElements": { "type": "integer", "description": "Total number of elements", "format": "int64", "example": 25 } }, "description": "Page token representation for search result" } + Response 400 (application/json) Request has incorrect values + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "validation", "title": "string", "detail": "string", "invalidFields": [ { "name": "string", "channelType": "PHONE", "code": "must_not_be_empty", "reason": "string", "invalidIds": [ "string" ] } ] } + Schema { "required": [ "detail", "invalidFields", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" }, "invalidFields": { "type": "array", "description": "List of invalid fields", "items": { "$ref": "#/components/schemas/InvalidInputField" } } }, "description": "Invalid input error data" } + Response 401 No valid authentication details were provided + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unauthorized", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 403 The authenticated user or account doesn't have permission + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "forbidden", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 500 (application/json) Internal server error + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "internal_server_error", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 501 (application/json) Request not recognised + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "request_not_recognised", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 502 (application/json) Invalid server response + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "bad_gateway", "title": "Title", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 503 (application/json) Server currently unavailable + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" } + Response 504 (application/json) Gateway time out + Body { "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "unknown", "title": "Internal error", "detail": "Extra details" } + Schema { "required": [ "detail", "title", "type", "uuid" ], "type": "object", "properties": { "uuid": { "type": "string", "description": "Error id in UUID format", "format": "uuid" }, "type": { "type": "string", "description": "Error type", "enum": [ "validation", "not_found", "method_not_allowed", "conflict", "payload_too_large", "unsupported_media_type", "message_not_readable", "internal_server_error", "request_not_recognised", "forbidden", "bad_gateway", "payment_required", "unauthorized", "unknown" ] }, "title": { "type": "string", "description": "Error title" }, "detail": { "type": "string", "description": "Error additional details" } }, "description": "Api error data" }