Welcome to the NOMI API! This section will guide you through the initial steps to use our API, ensuring you have everything you need to start sending and managing SMS messages through your applications.
\nTo authenticate with the NOMI API, you'll need an API key. Follow these steps to generate one:
\nAPI keys section.Once generated, your API key will be your gateway to integrating with the NOMI API.
\nTo make API calls, append your API key to the request URL as a parameter. Here’s how you can do it:
\nhttps://api.withnomi.ai/account/balance?apikey=your_api_key_here
\nKeep your API key secure to prevent unauthorized access. If you make an API call without a valid API key, or if the key is incorrect, the API will return a 401 Unauthorized status code. This indicates that the request has not been completed due to invalid authentication credentials.
With your API key set up and understood how to use it within your API calls, you are now ready to explore the full potential of the NOMI API. This will allow you to seamlessly integrate SMS messaging capabilities into your applications and services.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"40983365","collectionId":"5d30bbab-50ae-4e83-9588-348df9e3f32d","publishedId":"2sBXcDHMyM","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-02-19T00:21:40.000Z"},"item":[{"name":"Account","item":[{"name":"Get Account Balance","id":"49b8cead-98d3-4ec8-ad35-81ac347c723f","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.withnomi.ai/account/balance","description":"This endpoint makes an HTTP GET request to retrieve the account balance from the specified URL. The response will be in JSON format and will include a \"success\" indicator, the \"balance\" data, and an optional \"message\" field.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ YOUR_API_KEY }}"}]},"isInherited":true,"source":{"_postman_id":"5d30bbab-50ae-4e83-9588-348df9e3f32d","id":"5d30bbab-50ae-4e83-9588-348df9e3f32d","name":"NOMI API","type":"collection"}},"urlObject":{"protocol":"https","path":["account","balance"],"host":["api","withnomi","ai"],"query":[],"variable":[]}},"response":[{"id":"b1247862-709b-49b5-939f-c817628e7525","name":"Successful Response","originalRequest":{"method":"GET","header":[],"url":"https://api.withnomi.ai/account/balance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 31 Mar 2024 22:51:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=xOWD2903xqPhKAL3mfjb3wu4w2cnluMAY8klX6BnFbQDi5HfNNtAFdjCmHlFQMGAzEMI2%2B9WU%2FlbRml6Ce2nlAF7dJLpvwiL%2BsPl%2BLrmuiAGygwSJwzWf91fcbK0ig%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"86d3e7ab188ee21b-ORD"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"balance\": 0\n },\n \"message\": \"Account balance retrieved\"\n}"}],"_postman_id":"49b8cead-98d3-4ec8-ad35-81ac347c723f"}],"id":"09f1e9b6-07b3-4630-8c71-ecce3a8ab849","_postman_id":"09f1e9b6-07b3-4630-8c71-ecce3a8ab849","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ YOUR_API_KEY }}"}]},"isInherited":true,"source":{"_postman_id":"5d30bbab-50ae-4e83-9588-348df9e3f32d","id":"5d30bbab-50ae-4e83-9588-348df9e3f32d","name":"NOMI API","type":"collection"}}},{"name":"Campaigns","item":[{"name":"Lookup Campaigns","id":"61776690-581b-4152-9e2e-3cd59ee8d980","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"campaign_id","value":"100","description":"(Optional) Id of campaign
\n","type":"text"},{"key":"name","value":"product","description":"(Optional) Text to search for in campaign name
\n","type":"text"},{"key":"status","value":"complete","description":"(Optional) Campaign status, must be 'draft', 'pending', 'failed', or 'complete'
\n","type":"text"},{"key":"page","value":"1","description":"(Optional) Page number for results (Default 1)
\n","type":"text"},{"key":"amount","value":"100","description":"(Optional) Amount of results per page (Default 10, max 100)
\n","type":"text"}]},"url":"https://api.withnomi.ai/campaigns/lookup","description":"This endpoint allows you to search for campaigns using various optional parameters. You can search by campaign ID, name, status, and paginate the results. The amount parameter allows you to control the number of results per page. The response will include details of the campaigns matching the search criteria.
\ncampaign_id (Optional) - Id of the campaign
name (Optional) - Text to search for in campaign name
status (Optional) - Campaign status, must be 'draft', 'pending', 'failed', or 'complete'
page (Optional) - Page number for results (Default 1)
amount (Optional) - Amount of results per page (Default 10, max 100)
success - Indicates if the request was successfuldata - Object containing details of the campaignscurrent_page - Current page number of the resultsper_page - Number of results per pagetotal_campaigns - Total number of campaignscampaigns - Array of campaign objects containing details such as campaign_id, name, status, number, url, message, media, revenue, conversions, sent, filtered, unsubscribed, send_at, sent_at, completed_at, failed, delivered, updated_at, created_atmessage - Additional information or error message(Optional) First name of contact
\n","type":"text"},{"key":"last_name","value":"Doe","description":"(Optional) Last name of contact
\n","type":"text"},{"key":"email","value":"john.doe@example.com","description":"(Optional) Email address of contact
\n","type":"text"},{"key":"phone","value":"5555555555","description":"(Required) Phone number of contact
\n","type":"text"},{"key":"tags","value":"buyer","description":"(Optional) Apply new tags to the contact, for multiple tags seperate by comma
\n","type":"text"},{"key":"remove_tags","value":"lead","description":"(Optional) Only if contact already exists and update is true, for multiple tags seperate by comma
\n","type":"text"},{"key":"custom_variables[order_id]","value":"ORD-12345","description":"(Optional) Custom variable key-value pairs (e.g., order_id, tracking_number)
\n","type":"text","disabled":true},{"key":"custom_variables[tracking_number]","value":"TRK-67890","description":"(Optional) Custom variable key-value pairs
\n","type":"text","disabled":true},{"key":"update","value":"true","description":"(Optional) Update the contact if they already exist (Default True)
\n","type":"text"},{"key":"sms_consent[status]","value":"subscribed","description":"(Optional) SMS consent status: subscribed, unsubscribed, pending, or transactional_only. Only applied to NEW contacts, ignored on update.
\n","type":"text","disabled":true},{"key":"sms_consent[timestamp]","value":"2026-01-15T10:30:00Z","description":"(Required with sms_consent) ISO 8601 date when consent was given
\n","type":"text","disabled":true},{"key":"sms_consent[source]","value":"webform","description":"(Required with sms_consent) Source of consent: checkout, webform, keyword, api, manual, stop, unsubscribe_link, spam_report
\n","type":"text","disabled":true},{"key":"sms_consent[consent_text]","value":"I agree to receive SMS marketing messages.","description":"(Required for SMS marketing opt-in) The consent language shown to the user
\n","type":"text","disabled":true},{"key":"sms_consent[ip_address]","value":"192.168.1.1","description":"(Optional) IP address of the user when consent was given
\n","type":"text","disabled":true},{"key":"sms_consent[user_agent]","value":"Mozilla/5.0","description":"(Optional) User agent of the browser when consent was given
\n","type":"text","disabled":true},{"key":"email_consent[status]","value":"subscribed","description":"(Optional) Email consent status: subscribed, unsubscribed, pending, or transactional_only. Only applied to NEW contacts, ignored on update.
\n","type":"text","disabled":true},{"key":"email_consent[timestamp]","value":"2026-01-15T10:30:00Z","description":"(Required with email_consent) ISO 8601 date when consent was given
\n","type":"text","disabled":true},{"key":"email_consent[source]","value":"webform","description":"(Required with email_consent) Source of consent: checkout, webform, keyword, api, manual, stop, unsubscribe_link, spam_report
\n","type":"text","disabled":true},{"key":"email_consent[ip_address]","value":"192.168.1.1","description":"(Optional) IP address of the user when consent was given
\n","type":"text","disabled":true},{"key":"email_consent[user_agent]","value":"Mozilla/5.0","description":"(Optional) User agent of the browser when consent was given
\n","type":"text","disabled":true}]},"url":"https://api.withnomi.ai/contacts/create","description":"This endpoint allows you to create a new contact in the system.
\nfirst_name (optional): First name of the contact.last_name (optional): Last name of the contact.email (optional): Email address of the contact.phone (required): Phone number of the contact.tags (optional): Apply new tags to the contact. For multiple tags, separate by comma.remove_tags (optional): Only if contact already exists and update is true. For multiple tags, seperate by comma.custom_variables (optional): Custom variable key-value pairs (e.g., custom_variables[order_id]=ORD-12345). Use these to store dynamic data like order IDs, tracking numbers, etc. that can be used in message templates with [order_id], [tracking_number] tokens.update (optional): Update the contact if they already exist. Default is True.Consent fields are only applied when creating a new contact. They are ignored on update/duplicate.
\nsms_consent (optional): Object containing SMS consent data.sms_consent[status] (required with sms_consent): One of subscribed, unsubscribed, pending, transactional_only.sms_consent[timestamp] (required with sms_consent): ISO 8601 date of when consent was given.sms_consent[source] (required with sms_consent): One of checkout, webform, keyword, api, manual, stop, unsubscribe_link, spam_report.sms_consent[consent_text] (required for SMS marketing opt-in): The consent language shown to the user.sms_consent[ip_address] (optional): IP address when consent was given.sms_consent[user_agent] (optional): User agent when consent was given.email_consent (optional): Object containing email consent data.email_consent[status] (required with email_consent): One of subscribed, unsubscribed, pending, transactional_only.email_consent[timestamp] (required with email_consent): ISO 8601 date of when consent was given.email_consent[source] (required with email_consent): One of checkout, webform, keyword, api, manual, stop, unsubscribe_link, spam_report.email_consent[ip_address] (optional): IP address when consent was given.email_consent[user_agent] (optional): User agent when consent was given.If no consent information is provided, the contact is treated as transactional-only (can receive transactional messages but not marketing).
\nUpon successful creation, the response will include:
\ncontact_id: The ID of the created contact.first_name: First name of the contact.last_name: Last name of the contact.email: Email address of the contact.phone: Phone number of the contact.tags: Array of tags associated with the contact.custom_variables: Object containing custom variable key-value pairs.timezone: Timezone of the contact.state: State of the contact.unsubscribed_at: Date and time when the contact unsubscribed, if applicable.updated_at: Date and time of the last update.created_at: Date and time of creation.sms_consent_status: Current SMS consent status (only returned for new contacts).email_consent_status: Current email consent status (only returned for new contacts).consent_events: Array of recorded consent events (only returned for new contacts when consent was provided).In case of an error, the response will include a relevant error message.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"apikey"},{"key":"value","value":"{{ YOUR_API_KEY }}"}]},"isInherited":true,"source":{"_postman_id":"5d30bbab-50ae-4e83-9588-348df9e3f32d","id":"5d30bbab-50ae-4e83-9588-348df9e3f32d","name":"NOMI API","type":"collection"}},"urlObject":{"protocol":"https","path":["contacts","create"],"host":["api","withnomi","ai"],"query":[],"variable":[]}},"response":[{"id":"18bd966a-ab0c-44ee-b416-a1c6003ba3a4","name":"Successful Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"first_name","value":"John","description":"(Optional) First name of contact","type":"text"},{"key":"last_name","value":"Doe","description":"(Optional) Last name of contact","type":"text"},{"key":"phone","value":"5555555555","description":"(Required) Phone number of contact","type":"text"},{"key":"tags","value":"tester","description":"(Optional) Tags associated with contact, for multiple tags seperate by comma","type":"text"},{"key":"update","value":"true","description":"(Optional) Update the contact if they already exist (Default True)","type":"text"}]},"url":"https://api.withnomi.ai/contacts/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 31 Mar 2024 21:12:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=u34yp9nKgQdnEr4r3Mcwk14ULAB45oO35BIE3%2BZUbIq4D9tK6ZHWrrg7OKHwwVFeCp1eem5WkN%2F2%2FSLUFpXH2VvyKzPe6bx0bQAeSj1Xp6wE528oVus38v2nzV9TzA%3D%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"86d356806eed6094-ORD"},{"key":"Content-Encoding","value":"br"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"contact_id\": 178,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"john.doe@example.com\",\n \"phone\": \"+15555555555\",\n \"tags\": [\n \"tester\"\n ],\n \"custom_variables\": {},\n \"timezone\": \"America/Los_Angeles\",\n \"state\": \"CA\",\n \"unsubscribed_at\": null,\n \"updated_at\": \"2024-03-31T21:12:30.000000Z\",\n \"created_at\": \"2024-03-31T21:12:30.000000Z\",\n \"sms_consent_status\": \"subscribed\",\n \"email_consent_status\": null,\n \"consent_events\": [\n {\n \"channel\": \"sms\",\n \"status\": \"subscribed\",\n \"source\": \"webform\"\n }\n ]\n },\n \"message\": \"Contact created successfully\"\n}"}],"_postman_id":"2b6920f4-5a8a-4503-90c8-ddcb1f2afa16"},{"name":"Lookup Contacts","event":[{"listen":"test","script":{"exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Response is an object with success property\", function () {"," pm.expect(pm.response.json()).to.be.an('object').that.has.property('success');","});","","pm.test(\"Data object contains contact_id, phone, and tags properties\", function () {"," var data = pm.response.json().data;"," pm.expect(data).to.be.an('object').that.includes.all.keys('contact_id', 'phone', 'tags');","});"],"type":"text/javascript","packages":{},"requests":{},"id":"8b6da6fe-ae94-4df1-9aec-321bfd1ca121"}}],"id":"81728a00-206f-4158-8897-31917e8de5ee","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"first_name","value":"John","description":"(Optional) First name of contact
\n","type":"text"},{"key":"last_name","value":"Doe","description":"(Optional) Last name of contact
\n","type":"text"},{"key":"email","value":"john.doe@example.com","description":"(Optional) Email address of contact
\n","type":"text"},{"key":"phone","value":"5555555555","description":"(Optional) Phone number of contact
\n","type":"text"},{"key":"tags","value":"tester","description":"(Optional) Tags associated with contact, for multiple tags seperate by comma. Results will be matched for all tags included
\n","type":"text"},{"key":"contact_id","value":"178","description":"(Optional) Id of the contact
\n","type":"text"},{"key":"state","value":"CA","description":"(Optional) 2 letter state abbreviation
\n","type":"text"},{"key":"page","value":"1","description":"(Optional) Page number for results (Default 1)
\n","type":"text"},{"key":"amount","value":"20","description":"(Optional) Amount of results per page (Default 20, max 200)
\n","type":"text"}]},"url":"https://api.withnomi.ai/contacts/lookup","description":"This endpoint is used to look up contacts with optional parameters such as first name, last name, email, phone number, tags, contact ID, state, page number, and amount of results per page.
\nRequest Body Parameters:
\nfirst_name (Optional) - First name of contactlast_name (Optional) - Last name of contactemail (Optional) - Email address of contactphone (Optional) - Phone number of contacttags (Optional) - Tags associated with contact, for multiple tags separate by comma. Results will be matched for all tags includedcontact_id (Optional) - Id of the contactstate (Optional) - 2 letter state abbreviationpage (Optional) - Page number for results (Default 1)amount (Optional) - Amount of results per page (Default 20, max 200)Response Fields:
\nEach contact in the response includes:
\nsms_consent_status - Current SMS consent status (subscribed, unsubscribed, pending, transactional_only, or null)email_consent_status - Current email consent status (subscribed, unsubscribed, pending, transactional_only, or null)(Required if phone is not present) Id of the contact to be updated
\n","type":"text"},{"key":"first_name","value":"John","description":"(Optional) First name of contact to update
\n","type":"text"},{"key":"last_name","value":"Smith","description":"(Optional) Last name of contact to update
\n","type":"text"},{"key":"email","value":"john.smith@example.com","description":"(Optional) Email address of contact to update
\n","type":"text"},{"key":"phone","value":"5555555555","description":"(Required if contact_id is not present) Phone number of contact to update
\n","type":"text"},{"key":"tags","value":"tester","description":"(Optional) Apply new tags to the contact, for multiple tags seperate by comma
\n","type":"text"},{"key":"remove_tags","value":"tested","description":"(Optional) Tags to remove from contact, for multiple tags seperate by comma
\n","type":"text"},{"key":"merge_tags","value":"true","description":"(Optional) Merge tags if true, overwrite tags if false (Default true)
\n","type":"text"},{"key":"custom_variables[order_id]","value":"ORD-12345","description":"(Optional) Add or update custom variables
\n","type":"text","disabled":true},{"key":"custom_variables[order_status]","value":"shipped","description":"(Optional) Add or update custom variables
\n","type":"text","disabled":true},{"key":"remove_custom_variables[]","value":"discount_code","description":"(Optional) Remove specific custom variable keys
\n","type":"text","disabled":true},{"key":"merge_custom_variables","value":"true","description":"(Optional) Merge custom variables if true, overwrite if false (Default true)
\n","type":"text","disabled":true}]},"url":"https://api.withnomi.ai/contacts/update","description":"This API endpoint allows you to update a contact's information. If the contact_id is not present, you must provide the phone number of the contact to be updated. You can include the first name, last name, email, tags, custom variables, and merge options in the payload to update the contact's details.
\ncontact_id (text, required if phone is not present): Id of the contact to be updated.first_name (text, optional): First name of the contact to update.last_name (text, optional): Last name of the contact to update.email (text, optional): Email address of the contact to update.phone (text, required if contact_id is not present): Phone number of the contact to update.tags (text, optional): Apply new tags to the contact. For multiple tags, separate by comma.remove_tags (text, optional): Tags to remove from the contact. For multiple tags, separate by comma.merge_tags (text, optional): Merge tags if true, overwrite tags if false (Default true).custom_variables (array, optional): Add or update custom variables (e.g., custom_variables[order_id]=ORD-12345).remove_custom_variables (array, optional): Array of custom variable keys to remove (e.g., remove_custom_variables[]=discount_code).merge_custom_variables (text, optional): Merge custom variables if true, overwrite if false (Default true).Upon successful execution, the API returns a JSON response with a status code of 200 and the following structure:
\ncontact_id - The ID of the contact.first_name - First name of the contact.last_name - Last name of the contact.email - Email address of the contact.phone - Phone number of the contact.tags - Tags associated with the contact.custom_variables - Object containing custom variable key-value pairs.timezone - Timezone of the contact.state - State of the contact.unsubscribed_at - Date and time when the contact unsubscribed, if applicable.updated_at - Date and time of the last update.created_at - Date and time of creation.In case of an error, the response will include a message indicating the issue.
(Required if email is not present) Phone number of contact
\n","type":"text"},{"key":"email","value":"john.doe@example.com","description":"(Required if phone is not present) Email address of contact
\n","type":"text"},{"key":"type","value":"both","description":"(Optional) Unsubscribe type: 'sms', 'email', or 'both' (Default: both)
\n","type":"text"}]},"url":"https://api.withnomi.ai/contacts/unsubscribe","description":"This API endpoint allows you to unsubscribe a contact from SMS and/or email communications.
\nNote: SMS contacts who are unsubscribed can only be resubscribed by texting START.
\nUnsubscribe from SMS only:
\nUnsubscribe from email only:
\nUnsubscribe from both (default):
\nRecord a new consent event for a contact. This is an immutable, append-only audit log of all consent changes.
\nRequires: update token ability
contact_id (required): The internal ID of the contact.channel (required): sms or emailstatus (required): One of subscribed, unsubscribed, pending, transactional_onlysource (required): One of checkout, webform, keyword, api, manual, stop, unsubscribe_link, spam_reporttimestamp (required): ISO 8601 date of when consent was givenconsent_text (required for SMS marketing opt-in): The consent language shown to the userip_address (optional): IP address when consent was givenuser_agent (optional): User agent when consent was givenIf a contact recently unsubscribed, re-subscribing may be blocked by a cooling-off period (default 48 hours). The keyword source bypasses this restriction (e.g., texting START).
consent_event_id: ID of the newly created consent eventcontact_id: The contact's internal IDchannel: sms or emailstatus: The recorded consent statussource: The source of the consent changeevent_timestamp: When consent was givencreated_at: When the record was createdRetrieve the full consent event history for a contact, ordered by most recent first.
\nRequires: read token ability
contact_id (required): The internal ID of the contact.channel (optional): Filter events by channel (sms or email). If omitted, all events are returned.contact_id: The contact's internal IDcurrent_sms_status: Current derived SMS consent statuscurrent_email_status: Current derived email consent statusconsent_events: Array of consent events, each containing:id: Event IDchannel: sms or emailstatus: The consent status recordedsource: The source of the changeevent_timestamp: When consent was givenip_address: IP address (if recorded)consent_text: Consent language (if recorded)created_at: When the record was created(Optional) Filter by channel: sms or email
\n","type":"text/plain"},"key":"channel","value":"sms"}],"variable":[]}},"response":[{"id":"602a3ff5-879b-411d-beaf-9a50b8aadaf9","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.withnomi.ai/contacts/178/consent"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"contact_id\": 178,\n \"current_sms_status\": \"subscribed\",\n \"current_email_status\": null,\n \"consent_events\": [\n {\n \"id\": 1,\n \"channel\": \"sms\",\n \"status\": \"subscribed\",\n \"source\": \"webform\",\n \"event_timestamp\": \"2026-01-15T10:30:00+00:00\",\n \"ip_address\": \"192.168.1.1\",\n \"consent_text\": \"I agree to receive SMS marketing messages.\",\n \"created_at\": \"2026-01-15T10:31:00+00:00\"\n }\n ]\n },\n \"message\": \"Consent history retrieved successfully\"\n}"}],"_postman_id":"b7a1aefe-4ada-4f3f-8d04-c25b347c6a9e"},{"name":"Get Consent Status","id":"943de8a9-fa38-4018-8f45-66055facda89","protocolProfileBehavior":{"disabledSystemHeaders":{"accept":true},"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"https://api.withnomi.ai/contacts/178/consent/status","description":"Get the current consent status summary for a contact, including whether they can receive marketing and transactional messages for each channel.
\nRequires: read token ability
contact_id (required): The internal ID of the contact.contact_id: The contact's internal IDsms: SMS consent detailsstatus: Current SMS consent status (subscribed, unsubscribed, pending, transactional_only, or null)updated_at: When the SMS consent was last changedcan_receive_marketing: Whether the contact can receive SMS marketing messagescan_receive_transactional: Whether the contact can receive transactional SMSemail: Email consent detailsstatus: Current email consent statusupdated_at: When the email consent was last changedcan_receive_marketing: Whether the contact can receive email marketingcan_receive_transactional: Whether the contact can receive transactional email(Required) Id generated by a short code url
\n","type":"text"},{"key":"amount","value":"100","description":"(Required) Amount the conversion is worth
\n","type":"text"}]},"url":"https://api.withnomi.ai/conversion","description":"This endpoint allows you to submit a POST request to https://api.withnomi.ai/conversion in order to initiate a conversion process.
\nNote: No auth is needed on this endpoint
\n(Required if phone is not present) Id of contact
\n","type":"text"},{"key":"phone","value":"5555555555","description":"(Required if contact_id is not present) Phone number of contact
\n","type":"text"},{"key":"page","value":"1","description":"(Optional) Page number for results (Default 1)
\n","type":"text"},{"key":"amount","value":"1","description":"(Optional) Amount of results per page (Default 10, max 100)
\n","type":"text"}]},"url":"https://api.withnomi.ai/messages/lookup","description":"This endpoint is used to look up messages with the given criteria.
\ncontact_id (text, required if phone is not present): Id of contact
phone (text, required if contact_id is not present): Phone number of contact
page (text, optional): Page number for results (Default 1)
amount (text, optional): Amount of results per page (Default 10, max 100)
(Required if phone is not present) Id of contact
\n","type":"text"},{"key":"phone","value":"5555555555","description":"(Required if contact_id is not present) Phone number of contact
\n","type":"text"},{"key":"first_name","value":"John","description":"(Optional) First name of contact
\n","type":"text"},{"key":"last_name","value":"Smith","description":"(Optional) Last name of contact
\n","type":"text"},{"key":"tags","value":"tester","description":"(Optional) Tags associated with contact, for multiple tags seperate by comma
\n","type":"text"},{"key":"message","value":"API Test Message [link]","description":"(Required) Message body to be sent
\n","type":"text"},{"key":"number_id","value":"1","description":"(Optional) The id of your number, if your account has multiple numbers (Default 1)
\n","type":"text"},{"key":"media_url","value":"https://withnomi.ai/images/logo.png","description":"(Optional) Public URL of media you would like attached to the sms
\n","type":"text"},{"key":"promo_url","value":"https://google.com","description":"(Optional) If you would like to generate a short code for your promotional url, add [link] token to message body to populate
\n","type":"text"}]},"url":"https://api.withnomi.ai/messages/create","description":"This API endpoint allows you to create and send a message to a contact via the specified platform. The request should be sent as an HTTP POST to the given URL. The request body should be of form-data type and include parameters for contact information, message body, and optional settings.
\nNote: If the contact exists the tags will be added and name updated. If the contact does not exist it will be created.
\nYou can use the following tokens in your message body that will be automatically replaced:
\nStandard Tokens:
\n[name] - Full name (first + last)[first_name] - First name only[last_name] - Last name only[st] - State abbreviation (e.g., \"CA\")[state] - Full state name (e.g., \"California\")[link] - Short link (if promo_url is provided)Custom Variables:
\n[order_id], [tracking_number])/contacts/create or /contacts/update endpointscontact_id (text, required if phone is not present): Id of the contact.phone (text, required if contact_id is not present): Phone number of the contact.first_name (text, optional): First name of the contact.last_name (text, optional): Last name of the contact.tags (text, optional): Tags associated with the contact. For multiple tags, separate by comma.message (text, required): Message body to be sent. Supports token replacement (see Message Tokens above).number_id (text, optional): The id of your number, if your account has multiple numbers (Default 1).media_url (text, optional): Public URL of media to be attached to the SMS.promo_url (text, optional): If you would like to generate a short code for your promotional URL, add [link] token to message body to populate. Also supports custom variable tokens.Upon successful execution, the API returns a JSON response with a status code of 200 and the following structure:
\nsuccess: Indicates if the request was successful.data: An array of data (if any) related to the request.message: Any additional message or information related to the request.