{"info":{"_postman_id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","name":"GoHighLevel API V1.1.20","description":"
\n

API v1 is End-of-Life and is no longer maintained. Please use v2 API.

\n
\n
\n

Please use the v2 API - https://highlevel.stoplight.io/docs/integrations/0443d7d1a4bd0-api-2-0-overview

\n
\n
\n

If you're using API v1 and encountering difficulties with the transition to API v2, please share your feedback with us at https://ideas.gohighlevel.com/apis

\n
\n
\n

For any queries email us at support@gohighlevel.com

\n
\n

Welcome

\n

Welcome to the GoHighLevel Developer Documentation Portal. This is documentation for public APIs provide by us which you can use use to automate some process or build any custom integration.In order to use this APIs you will need API Keys (Location/Agency).

\n
    \n
  1. Agency API Key
    2. \n
\n\n

2. Location API Key

\n\n

Important Announcement for API Rate Limit

\n
    \n

  1. For Burst Requests - 100/10 seconds

    \n
    2. \n

  2. For Daily - 200,000/Day

    \n
    3. \n
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"12456320","collectionId":"81ab1e0e-f09e-4771-a54b-be56ecdde267","publishedId":"UVXgNdmt","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2025-08-06T07:54:00.000Z"},"item":[{"name":"Calendar","item":[{"name":"Calendar/Team","item":[{"name":"/v1/calendars/teams","id":"d366cbd0-b2ad-452b-920a-6a36b7a7d16b","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/calendars/teams","description":"

Get all teams.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","calendars","teams"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[]}},"response":[{"id":"a2358ef6-1254-4bd0-a88c-31cd086fff2a","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/calendars/teams"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"teams\": [\n {\n \"id\": \"OW59k4IchTgKjIDy3VMO\",\n \"name\": \"Test Team\",\n \"members\": [\n {\n \"id\": \"mnUXmpG2MhhHKmjegzBZ\",\n \"name\": \"Elon Musk\",\n \"email\": \"elon@musk.com\"\n },\n {\n \"id\": \"mnUXmpG2MhhHKmjegzBZ\",\n \"name\": \"Elon Musk\",\n \"email\": \"elon@musk.com\"\n }\n ],\n \"calendarConfig\": {\n \"calendarName\": \"Test Calendar\",\n \"description\": \"Desc.\",\n \"slug\": \"slug\",\n \"link\": \"/widget/appointment/slug\",\n \"shouldAssignContactToTeamMember\": false,\n \"shouldSkipAssigningContactForExisting\": false\n }\n },\n {\n \"id\": \"OW59k4IchTgKjIDy3VMO\",\n \"name\": \"Test Team\",\n \"members\": [\n {\n \"id\": \"mnUXmpG2MhhHKmjegzBZ\",\n \"name\": \"Elon Musk\",\n \"email\": \"elon@musk.com\"\n },\n {\n \"id\": \"mnUXmpG2MhhHKmjegzBZ\",\n \"name\": \"Elon Musk\",\n \"email\": \"elon@musk.com\"\n }\n ],\n \"calendarConfig\": {\n \"calendarName\": \"Test Calendar\",\n \"description\": \"Desc.\",\n \"slug\": \"slug\",\n \"link\": \"/widget/appointment/slug\",\n \"shouldAssignContactToTeamMember\": false,\n \"shouldSkipAssigningContactForExisting\": false\n }\n }\n ]\n}"},{"id":"55e2b764-d8e0-4790-8636-4d756da6b637","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/calendars/teams"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"cb011d8a-bf4b-41be-8776-4c36eb90cd76","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/calendars/teams"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"d366cbd0-b2ad-452b-920a-6a36b7a7d16b"},{"name":"/v1/calendars/check-slug-availability/:slug","id":"964054d3-1170-4e99-8a33-db055302d4ac","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/calendars/check-slug-availability/:slug","description":"

Check Calendar (Provider) slug availability.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","calendars","check-slug-availability",":slug"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"46ff25a8-0bd5-4caf-96ed-07ce31ecf9fe","description":{"content":"

(Required) Slug

\n","type":"text/plain"},"type":"any","value":"xyz","key":"slug"}]}},"response":[{"id":"cbff4498-cb34-48a5-b071-9106341ebf0a","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/calendars/check-slug-availability/:slug","host":["https://rest.gohighlevel.com"],"path":["v1","calendars","check-slug-availability",":slug"],"variable":[{"key":"slug","value":"xyz","description":"(Required) Slug"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"slug\": \"sales-services\",\n \"isSlugAvailable\": true\n}"},{"id":"bf0e6d3b-6d9d-4816-8723-c4f8ae2223c5","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/calendars/check-slug-availability/:slug","host":["https://rest.gohighlevel.com"],"path":["v1","calendars","check-slug-availability",":slug"],"variable":[{"key":"slug","value":"xyz","description":"(Required) Slug"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"a8996f73-1239-4c01-9050-46af7962ecf6","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/calendars/check-slug-availability/:slug","host":["https://rest.gohighlevel.com"],"path":["v1","calendars","check-slug-availability",":slug"],"variable":[{"key":"slug","value":"xyz","description":"(Required) Slug"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"615b1a58-1bac-4d88-a944-42546d6c010b","name":"Unprocessable Entity","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/calendars/check-slug-availability/:slug","host":["https://rest.gohighlevel.com"],"path":["v1","calendars","check-slug-availability",":slug"],"variable":[{"key":"slug","value":"xyz","description":"(Required) Slug"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"email or phone\": {\n \"message\": \"The email or phone field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"964054d3-1170-4e99-8a33-db055302d4ac"},{"name":"/v1/calendars/teams/","id":"aa464fd5-26ab-4723-b5ff-f2c390c4482c","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sales Team\",\n \"userIds\": [\n \"nisi incididunt\",\n \"laboris veniam Ut\"\n ],\n \"calendarConfig\": {\n \"calendarName\": \"Sales Team Calendar\",\n \"description\": \"Sales Team Calendar Services\",\n \"slug\": \"sales-team\",\n \"shouldAssignContactToTeamMember\": false,\n \"shouldSkipAssigningContactForExisting\": false\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/calendars/teams/","description":"

Create a team.

Required JSON fields in the body

FieldsTypesExample
namestringTest Team
userIdsarray[\"J37gEVtdFMRYVQWPdXIc\"]
calendarConfigobject{\"calendarName\": \"test\", \"description\": \"dfsadfsd\", \"slug\": \"tesfdsafdsa\", \"link\": \"/widget/appointment/tesfdsafdsa\", \"shouldAssignContactToTeamMember\": false, \"shouldSkipAssigningContactForExisting\": false}

Required JSON fields in the calendarConfig

FieldsTypesExample
calendarNamestringFirst Calendar
descriptionstringSome description
slugstringfirst-calendar

Allowed JSON fields in the calendarConfig

FieldsTypesExample
shouldAssignContactToTeamMemberbooleanfalse
shouldSkipAssigningContactForExistingbooleanfalse

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","calendars","teams",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[]}},"response":[{"id":"48bf6c1e-f9cb-4718-9326-6e3b5562dbe4","name":"Successful response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sales Team\",\n \"userIds\": [\n \"ea est esse ad velit\",\n \"ex ut et eiusmod\"\n ],\n \"calendarConfig\": {\n \"calendarName\": \"Sales Team Calendar\",\n \"description\": \"Sales Team Calendar Services\",\n \"slug\": \"sales-team\",\n \"shouldAssignContactToTeamMember\": false,\n \"shouldSkipAssigningContactForExisting\": false\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/calendars/teams/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"OW59k4IchTgKjIDy3VMO\",\n \"name\": \"Test Team\",\n \"members\": [\n {\n \"id\": \"mnUXmpG2MhhHKmjegzBZ\",\n \"name\": \"Elon Musk\",\n \"email\": \"elon@musk.com\"\n },\n {\n \"id\": \"mnUXmpG2MhhHKmjegzBZ\",\n \"name\": \"Elon Musk\",\n \"email\": \"elon@musk.com\"\n }\n ],\n \"calendarConfig\": {\n \"calendarName\": \"Test Calendar\",\n \"description\": \"Desc.\",\n \"slug\": \"slug\",\n \"link\": \"/widget/appointment/slug\",\n \"shouldAssignContactToTeamMember\": false,\n \"shouldSkipAssigningContactForExisting\": false\n }\n}"},{"id":"dcc9da22-0282-4018-8eb0-6e9b0c9b3ded","name":"Bad Request. please contact support!","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sales Team\",\n \"userIds\": [\n \"ea est esse ad velit\",\n \"ex ut et eiusmod\"\n ],\n \"calendarConfig\": {\n \"calendarName\": \"Sales Team Calendar\",\n \"description\": \"Sales Team Calendar Services\",\n \"slug\": \"sales-team\",\n \"shouldAssignContactToTeamMember\": false,\n \"shouldSkipAssigningContactForExisting\": false\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/calendars/teams/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"f1c3f96d-2504-4d05-8cd1-6c7ae9f80b06","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sales Team\",\n \"userIds\": [\n \"ea est esse ad velit\",\n \"ex ut et eiusmod\"\n ],\n \"calendarConfig\": {\n \"calendarName\": \"Sales Team Calendar\",\n \"description\": \"Sales Team Calendar Services\",\n \"slug\": \"sales-team\",\n \"shouldAssignContactToTeamMember\": false,\n \"shouldSkipAssigningContactForExisting\": false\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/calendars/teams/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"f3f92f0d-0311-4358-911f-611dbe9a0399","name":"Unprocessable Entity","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sales Team\",\n \"userIds\": [\n \"ea est esse ad velit\",\n \"ex ut et eiusmod\"\n ],\n \"calendarConfig\": {\n \"calendarName\": \"Sales Team Calendar\",\n \"description\": \"Sales Team Calendar Services\",\n \"slug\": \"sales-team\",\n \"shouldAssignContactToTeamMember\": false,\n \"shouldSkipAssigningContactForExisting\": false\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/calendars/teams/"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": {\n \"message\": \"The name field is mandatory.\",\n \"rule\": \"required\"\n },\n \"userIds\": {\n \"message\": \"The user ids field is mandatory.\",\n \"rule\": \"required\"\n },\n \"calendarConfig.calendarName\": {\n \"message\": \"The calendarConfig.calendarName field is mandatory.\",\n \"rule\": \"required\"\n },\n \"calendarConfig.description\": {\n \"message\": \"The calendarConfig.description field is mandatory.\",\n \"rule\": \"required\"\n },\n \"calendarConfig.slug\": {\n \"message\": \"The calendarConfig.slug field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"aa464fd5-26ab-4723-b5ff-f2c390c4482c"},{"name":"/v1/calendars/teams/:teamId","id":"09849671-b73f-4ea7-ac37-dfe418f2650e","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sales Team\",\n \"userIds\": [\n \"ea est esse ad velit\",\n \"ex ut et eiusmod\"\n ],\n \"calendarConfig\": {\n \"calendarName\": \"Sales Team Calendar\",\n \"description\": \"Sales Team Calendar Services\",\n \"slug\": \"sales-team\",\n \"shouldAssignContactToTeamMember\": false,\n \"shouldSkipAssigningContactForExisting\": false\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/calendars/teams/:teamId","description":"

Updating existing team.

Required JSON fields in the body

FieldsTypesExample
namestringTest Team
userIdsarray[\"J37gEVtdFMRYVQWPdXIc\"]
calendarConfigobject{\"calendarName\": \"test\", \"description\": \"dfsadfsd\", \"slug\": \"tesfdsafdsa\", \"link\": \"/widget/appointment/tesfdsafdsa\", \"shouldAssignContactToTeamMember\": false, \"shouldSkipAssigningContactForExisting\": false}

Required JSON fields in the calendarConfig

FieldsTypesExample
calendarNamestringFirst Calendar
descriptionstringSome description
slugstringfirst-calendar

Allowed JSON fields in the calendarConfig

FieldsTypesExample
shouldAssignContactToTeamMemberbooleanfalse
shouldSkipAssigningContactForExistingbooleanfalse

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","calendars","teams",":teamId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"d03daae0-9332-45f2-aa09-54dfad4b32de","description":{"content":"

(Required) Team Id

\n","type":"text/plain"},"type":"any","value":"0nU7uKSrtT2RVM1KknuF","key":"teamId"}]}},"response":[{"id":"d76562be-42ae-4477-b0f3-a1d6f9f1f705","name":"Successful response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sales Team\",\n \"userIds\": [\n \"ea est esse ad velit\",\n \"ex ut et eiusmod\"\n ],\n \"calendarConfig\": {\n \"calendarName\": \"Sales Team Calendar\",\n \"description\": \"Sales Team Calendar Services\",\n \"slug\": \"sales-team\",\n \"shouldAssignContactToTeamMember\": false,\n \"shouldSkipAssigningContactForExisting\": false\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/calendars/teams/:teamId","host":["https://rest.gohighlevel.com"],"path":["v1","calendars","teams",":teamId"],"variable":[{"key":"teamId","value":"0nU7uKSrtT2RVM1KknuF","description":"(Required) Team Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"OW59k4IchTgKjIDy3VMO\",\n \"name\": \"Test Team\",\n \"members\": [\n {\n \"id\": \"mnUXmpG2MhhHKmjegzBZ\",\n \"name\": \"Elon Musk\",\n \"email\": \"elon@musk.com\"\n },\n {\n \"id\": \"mnUXmpG2MhhHKmjegzBZ\",\n \"name\": \"Elon Musk\",\n \"email\": \"elon@musk.com\"\n }\n ],\n \"calendarConfig\": {\n \"calendarName\": \"Test Calendar\",\n \"description\": \"Desc.\",\n \"slug\": \"slug\",\n \"link\": \"/widget/appointment/slug\",\n \"shouldAssignContactToTeamMember\": false,\n \"shouldSkipAssigningContactForExisting\": false\n }\n}"},{"id":"bf89a9e9-8fdf-40d9-aea7-daa4c2e40be6","name":"Bad Request. please contact support!","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sales Team\",\n \"userIds\": [\n \"ea est esse ad velit\",\n \"ex ut et eiusmod\"\n ],\n \"calendarConfig\": {\n \"calendarName\": \"Sales Team Calendar\",\n \"description\": \"Sales Team Calendar Services\",\n \"slug\": \"sales-team\",\n \"shouldAssignContactToTeamMember\": false,\n \"shouldSkipAssigningContactForExisting\": false\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/calendars/teams/:teamId","host":["https://rest.gohighlevel.com"],"path":["v1","calendars","teams",":teamId"],"variable":[{"key":"teamId","value":"0nU7uKSrtT2RVM1KknuF","description":"(Required) Team Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"de4017d8-c5ea-48c5-83c9-2dd55150bc65","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sales Team\",\n \"userIds\": [\n \"ea est esse ad velit\",\n \"ex ut et eiusmod\"\n ],\n \"calendarConfig\": {\n \"calendarName\": \"Sales Team Calendar\",\n \"description\": \"Sales Team Calendar Services\",\n \"slug\": \"sales-team\",\n \"shouldAssignContactToTeamMember\": false,\n \"shouldSkipAssigningContactForExisting\": false\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/calendars/teams/:teamId","host":["https://rest.gohighlevel.com"],"path":["v1","calendars","teams",":teamId"],"variable":[{"key":"teamId","value":"0nU7uKSrtT2RVM1KknuF","description":"(Required) Team Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"434ac0ee-7a1d-4564-8dee-d1beb3e2b99c","name":"Unprocessable Entity","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"Sales Team\",\n \"userIds\": [\n \"ea est esse ad velit\",\n \"ex ut et eiusmod\"\n ],\n \"calendarConfig\": {\n \"calendarName\": \"Sales Team Calendar\",\n \"description\": \"Sales Team Calendar Services\",\n \"slug\": \"sales-team\",\n \"shouldAssignContactToTeamMember\": false,\n \"shouldSkipAssigningContactForExisting\": false\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/calendars/teams/:teamId","host":["https://rest.gohighlevel.com"],"path":["v1","calendars","teams",":teamId"],"variable":[{"key":"teamId","value":"0nU7uKSrtT2RVM1KknuF","description":"(Required) Team Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": {\n \"message\": \"The name field is mandatory.\",\n \"rule\": \"required\"\n },\n \"userIds\": {\n \"message\": \"The user ids field is mandatory.\",\n \"rule\": \"required\"\n },\n \"calendarConfig.calendarName\": {\n \"message\": \"The calendarConfig.calendarName field is mandatory.\",\n \"rule\": \"required\"\n },\n \"calendarConfig.description\": {\n \"message\": \"The calendarConfig.description field is mandatory.\",\n \"rule\": \"required\"\n },\n \"calendarConfig.slug\": {\n \"message\": \"The calendarConfig.slug field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"09849671-b73f-4ea7-ac37-dfe418f2650e"},{"name":"/v1/calendars/teams/:teamId","id":"efade07f-73dd-4844-8019-07fb97533a25","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"DELETE","header":[],"url":"https://rest.gohighlevel.com/v1/calendars/teams/:teamId","description":"

Delete Team.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","calendars","teams",":teamId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"0e808d6e-409e-482e-b1c3-d78aea6081af","description":{"content":"

(Required) Team Id

\n","type":"text/plain"},"type":"any","value":"0nU7uKSrtT2RVM1KknuF","key":"teamId"}]}},"response":[{"id":"5c890532-3b58-4305-83a9-8f8aa2c7f805","name":"Successful response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/calendars/teams/:teamId","host":["https://rest.gohighlevel.com"],"path":["v1","calendars","teams",":teamId"],"variable":[{"key":"teamId","value":"0nU7uKSrtT2RVM1KknuF","description":"(Required) Team Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"395b3e5b-d38c-4dda-985c-1e4f873fcb25","name":"Bad Request. please contact support!","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/calendars/teams/:teamId","host":["https://rest.gohighlevel.com"],"path":["v1","calendars","teams",":teamId"],"variable":[{"key":"teamId","value":"0nU7uKSrtT2RVM1KknuF","description":"(Required) Team Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"bb3e290b-a6be-408f-9d93-eb4a3182630a","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/calendars/teams/:teamId","host":["https://rest.gohighlevel.com"],"path":["v1","calendars","teams",":teamId"],"variable":[{"key":"teamId","value":"0nU7uKSrtT2RVM1KknuF","description":"(Required) Team Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"efade07f-73dd-4844-8019-07fb97533a25"}],"id":"968cf580-1495-40df-b040-b6c29379246f","description":"

Fetch calendar and team

\n","_postman_id":"968cf580-1495-40df-b040-b6c29379246f","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","name":"GoHighLevel API V1.1.20","type":"collection"}}},{"name":"Calendar/Service","item":[{"name":"/v1/calendars/services","id":"86e4db4b-1856-4ae3-b2db-3a41bd8956a2","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/calendars/services?teamId=ABXdTR0kegkPcTvtdr1L","description":"

Get all calendar services.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","calendars","services"],"host":["https://rest.gohighlevel.com"],"query":[{"description":{"content":"

Filter service by team id.

\n","type":"text/plain"},"key":"teamId","value":"ABXdTR0kegkPcTvtdr1L"}],"variable":[]}},"response":[{"id":"62808123-3141-409c-a54b-99b2bfe6f100","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/calendars/services?teamId=ABXdTR0kegkPcTvtdr1L","host":["https://rest.gohighlevel.com"],"path":["v1","calendars","services"],"query":[{"key":"teamId","value":"ABXdTR0kegkPcTvtdr1L"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"services\": [\n {\n \"id\": \"OW59k4IchTgKjIDy3VMO\",\n \"name\": \"Test Service\",\n \"description\": \"Test Service Desc.\",\n \"appointmentTitle\": \"{{contact.name}}\",\n \"meetingLocation\": \"location\",\n \"eventColor\": \"#FF0000\",\n \"teamId\": \"#FF0000\",\n \"linkedCalendars\": {\n \"google\": {\n \"id\": \"eiusmod commodo non\",\n \"name\": \"pari\"\n },\n \"clio\": {\n \"id\": \"in labore Lorem ex\",\n \"name\": \"est nostrud\"\n },\n \"drchrono\": {\n \"id\": \"mollit sint\",\n \"name\": \"fugiat dolore non\"\n }\n },\n \"syncOption\": \"oneway\",\n \"teamMembers\": [\n {\n \"userId\": \"\",\n \"priority\": 0,\n \"selected\": false,\n \"meetingLocation\": \"https://zoom.us\"\n },\n {\n \"userId\": \"\",\n \"priority\": 0,\n \"selected\": false,\n \"meetingLocation\": \"https://zoom.us\"\n }\n ],\n \"availability\": {\n \"eventTiming\": {\n \"slotDuration\": 30,\n \"slotInterval\": 30,\n \"slotBuffer\": 0\n },\n \"appointmentInfo\": {\n \"perSlot\": 1,\n \"perDay\": 8\n },\n \"schedule\": {\n \"allowBookingAfter\": 1,\n \"allowBookingAfterUnit\": \"Hours\",\n \"allowBookingFor\": 8,\n \"allowBookingForUnit\": \"Hours\"\n },\n \"officeHours\": {\n \"monday\": [\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n },\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n }\n ],\n \"tuesday\": [\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n },\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n }\n ],\n \"wednesday\": [\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n },\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n }\n ],\n \"thursday\": [\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n },\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n }\n ],\n \"friday\": [\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n },\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n }\n ]\n }\n },\n \"confirmation\": {\n \"form\": {\n \"customFormId\": \"jjusM6EOngDExnbo2DbU\",\n \"stickyContact\": false\n },\n \"notificationAndOther\": {\n \"alertEmail\": \"quis aute\",\n \"hasAutoConfirm\": false,\n \"hasGoogleSendInvitationEmail\": false,\n \"hasAllowReschedule\": false,\n \"hasAllowCancellation\": false,\n \"hasSendEmailToAssignedMember\": false,\n \"notes\": \"\",\n \"facebookPixelId\": \"\",\n \"customCode\": \"\"\n },\n \"formSubmission\": {\n \"type\": \"ThankYouMessage\",\n \"content\": \"\"\n }\n }\n },\n {\n \"id\": \"OW59k4IchTgKjIDy3VMO\",\n \"name\": \"Test Service\",\n \"description\": \"Test Service Desc.\",\n \"appointmentTitle\": \"{{contact.name}}\",\n \"meetingLocation\": \"location\",\n \"eventColor\": \"#FF0000\",\n \"teamId\": \"#FF0000\",\n \"linkedCalendars\": {\n \"google\": {\n \"id\": \"in esse do non\",\n \"name\": \"laborum non proident veniam\"\n },\n \"clio\": {\n \"id\": \"aliqua aute dolore\",\n \"name\": \"esse\"\n },\n \"drchrono\": {\n \"id\": \"ullamco deserunt in\",\n \"name\": \"incidid\"\n }\n },\n \"syncOption\": \"oneway\",\n \"teamMembers\": [\n {\n \"userId\": \"\",\n \"priority\": 0,\n \"selected\": false,\n \"meetingLocation\": \"https://zoom.us\"\n },\n {\n \"userId\": \"\",\n \"priority\": 0,\n \"selected\": false,\n \"meetingLocation\": \"https://zoom.us\"\n }\n ],\n \"availability\": {\n \"eventTiming\": {\n \"slotDuration\": 30,\n \"slotInterval\": 30,\n \"slotBuffer\": 0\n },\n \"appointmentInfo\": {\n \"perSlot\": 1,\n \"perDay\": 8\n },\n \"schedule\": {\n \"allowBookingAfter\": 1,\n \"allowBookingAfterUnit\": \"Hours\",\n \"allowBookingFor\": 8,\n \"allowBookingForUnit\": \"Hours\"\n },\n \"officeHours\": {\n \"monday\": [\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n },\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n }\n ],\n \"tuesday\": [\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n },\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n }\n ],\n \"wednesday\": [\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n },\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n }\n ],\n \"thursday\": [\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n },\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n }\n ],\n \"friday\": [\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n },\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n }\n ]\n }\n },\n \"confirmation\": {\n \"form\": {\n \"customFormId\": \"jjusM6EOngDExnbo2DbU\",\n \"stickyContact\": false\n },\n \"notificationAndOther\": {\n \"alertEmail\": \"incididunt Duis\",\n \"hasAutoConfirm\": false,\n \"hasGoogleSendInvitationEmail\": false,\n \"hasAllowReschedule\": false,\n \"hasAllowCancellation\": false,\n \"hasSendEmailToAssignedMember\": false,\n \"notes\": \"\",\n \"facebookPixelId\": \"\",\n \"customCode\": \"\"\n },\n \"formSubmission\": {\n \"type\": \"ThankYouMessage\",\n \"content\": \"\"\n }\n }\n }\n ]\n}"},{"id":"c198402a-37f7-4421-88a2-63e453cd0189","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/calendars/services?teamId=ABXdTR0kegkPcTvtdr1L","host":["https://rest.gohighlevel.com"],"path":["v1","calendars","services"],"query":[{"key":"teamId","value":"ABXdTR0kegkPcTvtdr1L"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"62d70b9b-1ea5-4978-b6e4-e46f89050995","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/calendars/services?teamId=ABXdTR0kegkPcTvtdr1L","host":["https://rest.gohighlevel.com"],"path":["v1","calendars","services"],"query":[{"key":"teamId","value":"ABXdTR0kegkPcTvtdr1L"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"86e4db4b-1856-4ae3-b2db-3a41bd8956a2"},{"name":"/v1/calendars/services/","id":"c5b6a604-6673-409b-9a72-c103e0b47f71","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"teamId\": \"0RXEzw5UVe5oLFm6GQls\",\n \"eventType\": \"RoundRobin_OptimizeForAvailability\",\n \"teamMembers\": [\n {\n \"selected\": true,\n \"userId\": \"0nU7uKSrtT2RVM1KknuF\",\n \"priority\": \"Low\",\n \"meetingLocation\": \"PhoneNumber/ZoomLink/GoogleMeet/Location\"\n },\n {\n \"selected\": true,\n \"userId\": \"0nU7uKSrtT2RVM1KknuF\",\n \"priority\": \"Low\",\n \"meetingLocation\": \"PhoneNumber/ZoomLink/GoogleMeet/Location\"\n }\n ],\n \"name\": \"30 Mins Call\",\n \"description\": \"30 Minutes Call\",\n \"slug\": \"30-mins-call\",\n \"eventColor\": \"Peacock\",\n \"availability\": {\n \"eventTiming\": {\n \"slotDuration\": 30,\n \"slotInterval\": 30,\n \"slotBuffer\": 0\n },\n \"appointmentInfo\": {\n \"perSlot\": 0,\n \"perDay\": 0\n },\n \"schedule\": {\n \"allowBookingAfter\": 0,\n \"allowBookingAfterUnit\": \"days\",\n \"allowBookingFor\": 0,\n \"allowBookingForUnit\": \"days\"\n },\n \"officeHours\": {\n \"sunday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"monday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"tuesday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"wednesday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"thursday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"friday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"saturday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ]\n }\n },\n \"confirmation\": {\n \"form\": {\n \"customFormId\": \"\",\n \"stickyContact\": false,\n \"stripe\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"chargeDescription\": \"Your will be billed X amount for this appointment\"\n }\n },\n \"notificationAndOther\": {\n \"autoConfirm\": true,\n \"shouldSendAlertEmailsToAssignedMember\": true,\n \"googleInvitationEmails\": false,\n \"allowReschedule\": true,\n \"allowCancellation\": true,\n \"notes\": \"Phone:- {{contact.phone}} Email:- {{contact.email}} Need to make a change to this event? Reschedule:- {{reschedule_link}} Cancel:- {{cancellation_link}}\",\n \"facebookPixelId\": \"\"\n },\n \"formSubmission\": {\n \"type\": \"ThankYouMessage\",\n \"content\": \"https://www.bing.com or Thank you for your appointment request. We will contact you shortly to confirm your request. Please call our office at {{contactMethod}} if you have any questions.\"\n }\n },\n \"appointmentTitle\": \"{{contact.name}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/calendars/services/","description":"

Create a service

Required JSON fields in the body

FieldsTypesExampleAllowed Option?
teamIdstringO4qa8K1M6xA4oPXu1b8O
namestringAwsome Service
descriptionstringAwsome description
eventTypestringRoundRobin_OptimizeForAvailability
  • RoundRobin_OptimizeForAvailability
  • RoundRobin_OptimizeForEqualDistribution
teamMembersobbjectSee field info on the teamMembers table
slugstringawsome-service
appointmentTitlestring{{contact.name}}
eventColorstringTomato
  • Banana
  • Basil
  • Blueberry
  • Flamingo
  • Grape
  • Graphite
  • Lavender
  • Peacock
  • Sage
  • Tangerine
  • Tomato
availabilityobjectSee field info on availability table.
confirmationobjectSee field info on confirmation table.

Allowed JSON fields in the body

FieldsTypesExampleAllowed Option
isActivebooleantrue
syncOptionstringoneway
  • oneway
  • twoway
slugstringfirst-calendar

Allowed JSON fields in the teamMembers

FieldsTypesExampleAllowed Optionsis Required?
userIdstringGCs5KuzPqTls7vWclkEVYes
prioritystringHigh
  • High
  • Medium
  • Low
Yes
selectedbooleantrueYes
meetingLocationstringhttps://zoom.us/j/XXXXXXXXXXNo

Allowed JSON fields in the availability

FieldsTypesExampleis Required?
eventTimingobjectSee field info on availability.eventTiming table.Yes
officeHoursobjectSee field info on availability.officeHours table.Yes
appointmentInfoobjectSee field info on availability.appointmentInfo table.No
scheduleobjectSee field info on availability.schedule table.No

Allowed JSON fields in the availability.eventTiming

FieldsTypesExampleAllowed Optionsis Required?
slotDurationnumber30
  • 10
  • 15
  • 20
  • 30
  • 45
  • 60
  • 90
  • 120
  • 180
  • 240
  • 300
  • 360
  • 420
  • 480
Yes
slotIntervalnumber30
  • 10
  • 15
  • 20
  • 30
  • 45
  • 60
  • 90
  • 120
  • 180
  • 240
  • 300
  • 360
  • 420
  • 480
Yes
slotBuffernumber1No

Allowed JSON fields in the availability.appointmentInfo

FieldsTypesExampleis Required?
perSlotnumber1No
perDaynumber5No

Allowed JSON fields in the availability.schedule

FieldsTypesExampleAllowed Optionsis Required?
allowBookingAfternumber1No
allowBookingAfterUnitstringdays
  • hours
  • days
  • weeks
  • months
No
allowBookingFornumber5No
allowBookingForUnitstringdays
  • hours
  • days
  • weeks
  • months
No

Allowed JSON fields in the availability.officeHours

FieldsTypesExampleis Required?
mondayarrayPlease see field info availability.officeHours.days table. include as a array.Yes
tuesdayarrayPlease see field info availability.officeHours.days table. include as a array.Yes
wednesdayarrayPlease see field info availability.officeHours.days table. include as a array.Yes
thursdayarrayPlease see field info availability.officeHours.days table. include as a array.Yes
fridayarrayPlease see field info availability.officeHours.days table. include as a array.Yes

Allowed JSON fields in the availability.officeHours.days

FieldsTypesExampleis Required?
openMinutenumber0Yes
openHournumber8Yes
closeMinutenumber0Yes
closeHournumber17Yes

Allowed JSON fields in the confirmation

FieldsTypesExampleis Required?
formobjectSee field info on confirmation.form table.No
notificationAndOtherobjectSee field info on confirmation.notificationAndOther table.Yes
formSubmissionobjectSee field info on confirmation.formSubmission table.Yes

Allowed JSON fields in the confirmation.form

FieldsTypesExampleis Required?
customFormIdstringjjusM6EOngDExnbo2DbUNo
stickyContactbooleanfalseNo

Allowed JSON fields in the confirmation.notificationAndOther

FieldsTypesExampleis Required?
autoConfirmbooleanfalseYes
shouldSendAlertEmailsToAssignedMemberbooleanfalseYes
googleInvitationEmailsbooleanfalseYes
allowReschedulebooleanfalseYes
allowCancellationbooleanfalseYes
alertEmailstringjohn@deo.comNo
notesstringAwesome NotesNo
facebookPixelIdstringXXXXXXXXXXNo

Allowed JSON fields in the confirmation.formSubmission

FieldsTypesExampleAllowed Optionsis Required?
typestringThankYouMessage
  • ThankYouMessage
  • RedirectURL
Yes
contentstringThank you for your appointment request.Yes

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","calendars","services",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[]}},"response":[{"id":"27e77b31-0db3-483b-86c5-536c631ece93","name":"Successful response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"teamId\": \"0RXEzw5UVe5oLFm6GQls\",\n \"eventType\": \"RoundRobin_OptimizeForAvailability\",\n \"teamMembers\": [\n {\n \"selected\": true,\n \"userId\": \"0nU7uKSrtT2RVM1KknuF\",\n \"priority\": \"Low\",\n \"meetingLocation\": \"PhoneNumber/ZoomLink/GoogleMeet/Location\"\n },\n {\n \"selected\": true,\n \"userId\": \"0nU7uKSrtT2RVM1KknuF\",\n \"priority\": \"Low\",\n \"meetingLocation\": \"PhoneNumber/ZoomLink/GoogleMeet/Location\"\n }\n ],\n \"name\": \"30 Mins Call\",\n \"description\": \"30 Minutes Call\",\n \"slug\": \"30-mins-call\",\n \"eventColor\": \"Peacock\",\n \"availability\": {\n \"eventTiming\": {\n \"slotDuration\": 30,\n \"slotInterval\": 30,\n \"slotBuffer\": 0\n },\n \"appointmentInfo\": {\n \"perSlot\": 0,\n \"perDay\": 0\n },\n \"schedule\": {\n \"allowBookingAfter\": 0,\n \"allowBookingAfterUnit\": \"days\",\n \"allowBookingFor\": 0,\n \"allowBookingForUnit\": \"days\"\n },\n \"officeHours\": {\n \"sunday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"monday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"tuesday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"wednesday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"thursday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"friday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"saturday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ]\n }\n },\n \"confirmation\": {\n \"form\": {\n \"customFormId\": \"\",\n \"stickyContact\": false,\n \"stripe\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"chargeDescription\": \"Your will be billed X amount for this appointment\"\n }\n },\n \"notificationAndOther\": {\n \"autoConfirm\": true,\n \"shouldSendAlertEmailsToAssignedMember\": true,\n \"googleInvitationEmails\": false,\n \"allowReschedule\": true,\n \"allowCancellation\": true,\n \"notes\": \"Phone:- {{contact.phone}} Email:- {{contact.email}} Need to make a change to this event? Reschedule:- {{reschedule_link}} Cancel:- {{cancellation_link}}\",\n \"facebookPixelId\": \"\"\n },\n \"formSubmission\": {\n \"type\": \"ThankYouMessage\",\n \"content\": \"https://www.bing.com or Thank you for your appointment request. We will contact you shortly to confirm your request. Please call our office at {{contactMethod}} if you have any questions.\"\n }\n },\n \"appointmentTitle\": \"{{contact.name}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/calendars/services/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"OW59k4IchTgKjIDy3VMO\",\n \"name\": \"Test Service\",\n \"description\": \"Test Service Desc.\",\n \"appointmentTitle\": \"{{contact.name}}\",\n \"meetingLocation\": \"location\",\n \"eventColor\": \"#FF0000\",\n \"teamId\": \"#FF0000\",\n \"linkedCalendars\": {\n \"google\": {\n \"id\": \"adipisicing laboris veniam \",\n \"name\": \"ipsum fugiat ut\"\n },\n \"clio\": {\n \"id\": \"esse non adip\",\n \"name\": \"tempor Excepteur\"\n },\n \"drchrono\": {\n \"id\": \"magna in sunt veniam\",\n \"name\": \"ut sed adipisicing nisi\"\n }\n },\n \"syncOption\": \"oneway\",\n \"teamMembers\": [\n {\n \"userId\": \"\",\n \"priority\": 0,\n \"selected\": false,\n \"meetingLocation\": \"https://zoom.us\"\n },\n {\n \"userId\": \"\",\n \"priority\": 0,\n \"selected\": false,\n \"meetingLocation\": \"https://zoom.us\"\n }\n ],\n \"availability\": {\n \"eventTiming\": {\n \"slotDuration\": 30,\n \"slotInterval\": 30,\n \"slotBuffer\": 0\n },\n \"appointmentInfo\": {\n \"perSlot\": 1,\n \"perDay\": 8\n },\n \"schedule\": {\n \"allowBookingAfter\": 1,\n \"allowBookingAfterUnit\": \"Hours\",\n \"allowBookingFor\": 8,\n \"allowBookingForUnit\": \"Hours\"\n },\n \"officeHours\": {\n \"monday\": [\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n },\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n }\n ],\n \"tuesday\": [\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n },\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n }\n ],\n \"wednesday\": [\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n },\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n }\n ],\n \"thursday\": [\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n },\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n }\n ],\n \"friday\": [\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n },\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n }\n ]\n }\n },\n \"confirmation\": {\n \"form\": {\n \"customFormId\": \"jjusM6EOngDExnbo2DbU\",\n \"stickyContact\": false\n },\n \"notificationAndOther\": {\n \"alertEmail\": \"dolor elit\",\n \"hasAutoConfirm\": false,\n \"hasGoogleSendInvitationEmail\": false,\n \"hasAllowReschedule\": false,\n \"hasAllowCancellation\": false,\n \"hasSendEmailToAssignedMember\": false,\n \"notes\": \"\",\n \"facebookPixelId\": \"\",\n \"customCode\": \"\"\n },\n \"formSubmission\": {\n \"type\": \"ThankYouMessage\",\n \"content\": \"\"\n }\n }\n}"},{"id":"b2502fcb-597f-44b2-8d5b-419aa1014139","name":"Bad Request. please contact support!","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"teamId\": \"0RXEzw5UVe5oLFm6GQls\",\n \"eventType\": \"RoundRobin_OptimizeForAvailability\",\n \"teamMembers\": [\n {\n \"selected\": true,\n \"userId\": \"0nU7uKSrtT2RVM1KknuF\",\n \"priority\": \"Low\",\n \"meetingLocation\": \"PhoneNumber/ZoomLink/GoogleMeet/Location\"\n },\n {\n \"selected\": true,\n \"userId\": \"0nU7uKSrtT2RVM1KknuF\",\n \"priority\": \"Low\",\n \"meetingLocation\": \"PhoneNumber/ZoomLink/GoogleMeet/Location\"\n }\n ],\n \"name\": \"30 Mins Call\",\n \"description\": \"30 Minutes Call\",\n \"slug\": \"30-mins-call\",\n \"eventColor\": \"Peacock\",\n \"availability\": {\n \"eventTiming\": {\n \"slotDuration\": 30,\n \"slotInterval\": 30,\n \"slotBuffer\": 0\n },\n \"appointmentInfo\": {\n \"perSlot\": 0,\n \"perDay\": 0\n },\n \"schedule\": {\n \"allowBookingAfter\": 0,\n \"allowBookingAfterUnit\": \"days\",\n \"allowBookingFor\": 0,\n \"allowBookingForUnit\": \"days\"\n },\n \"officeHours\": {\n \"sunday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"monday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"tuesday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"wednesday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"thursday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"friday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"saturday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ]\n }\n },\n \"confirmation\": {\n \"form\": {\n \"customFormId\": \"\",\n \"stickyContact\": false,\n \"stripe\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"chargeDescription\": \"Your will be billed X amount for this appointment\"\n }\n },\n \"notificationAndOther\": {\n \"autoConfirm\": true,\n \"shouldSendAlertEmailsToAssignedMember\": true,\n \"googleInvitationEmails\": false,\n \"allowReschedule\": true,\n \"allowCancellation\": true,\n \"notes\": \"Phone:- {{contact.phone}} Email:- {{contact.email}} Need to make a change to this event? Reschedule:- {{reschedule_link}} Cancel:- {{cancellation_link}}\",\n \"facebookPixelId\": \"\"\n },\n \"formSubmission\": {\n \"type\": \"ThankYouMessage\",\n \"content\": \"https://www.bing.com or Thank you for your appointment request. We will contact you shortly to confirm your request. Please call our office at {{contactMethod}} if you have any questions.\"\n }\n },\n \"appointmentTitle\": \"{{contact.name}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/calendars/services/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"2565941c-65ca-4b74-b879-e151818ee1e9","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"teamId\": \"0RXEzw5UVe5oLFm6GQls\",\n \"eventType\": \"RoundRobin_OptimizeForAvailability\",\n \"teamMembers\": [\n {\n \"selected\": true,\n \"userId\": \"0nU7uKSrtT2RVM1KknuF\",\n \"priority\": \"Low\",\n \"meetingLocation\": \"PhoneNumber/ZoomLink/GoogleMeet/Location\"\n },\n {\n \"selected\": true,\n \"userId\": \"0nU7uKSrtT2RVM1KknuF\",\n \"priority\": \"Low\",\n \"meetingLocation\": \"PhoneNumber/ZoomLink/GoogleMeet/Location\"\n }\n ],\n \"name\": \"30 Mins Call\",\n \"description\": \"30 Minutes Call\",\n \"slug\": \"30-mins-call\",\n \"eventColor\": \"Peacock\",\n \"availability\": {\n \"eventTiming\": {\n \"slotDuration\": 30,\n \"slotInterval\": 30,\n \"slotBuffer\": 0\n },\n \"appointmentInfo\": {\n \"perSlot\": 0,\n \"perDay\": 0\n },\n \"schedule\": {\n \"allowBookingAfter\": 0,\n \"allowBookingAfterUnit\": \"days\",\n \"allowBookingFor\": 0,\n \"allowBookingForUnit\": \"days\"\n },\n \"officeHours\": {\n \"sunday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"monday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"tuesday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"wednesday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"thursday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"friday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"saturday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ]\n }\n },\n \"confirmation\": {\n \"form\": {\n \"customFormId\": \"\",\n \"stickyContact\": false,\n \"stripe\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"chargeDescription\": \"Your will be billed X amount for this appointment\"\n }\n },\n \"notificationAndOther\": {\n \"autoConfirm\": true,\n \"shouldSendAlertEmailsToAssignedMember\": true,\n \"googleInvitationEmails\": false,\n \"allowReschedule\": true,\n \"allowCancellation\": true,\n \"notes\": \"Phone:- {{contact.phone}} Email:- {{contact.email}} Need to make a change to this event? Reschedule:- {{reschedule_link}} Cancel:- {{cancellation_link}}\",\n \"facebookPixelId\": \"\"\n },\n \"formSubmission\": {\n \"type\": \"ThankYouMessage\",\n \"content\": \"https://www.bing.com or Thank you for your appointment request. We will contact you shortly to confirm your request. Please call our office at {{contactMethod}} if you have any questions.\"\n }\n },\n \"appointmentTitle\": \"{{contact.name}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/calendars/services/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"53dfe8b2-d34f-45b3-bb8c-3efab09f44d0","name":"Unprocessable Entity","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"teamId\": \"0RXEzw5UVe5oLFm6GQls\",\n \"eventType\": \"RoundRobin_OptimizeForAvailability\",\n \"teamMembers\": [\n {\n \"selected\": true,\n \"userId\": \"0nU7uKSrtT2RVM1KknuF\",\n \"priority\": \"Low\",\n \"meetingLocation\": \"PhoneNumber/ZoomLink/GoogleMeet/Location\"\n },\n {\n \"selected\": true,\n \"userId\": \"0nU7uKSrtT2RVM1KknuF\",\n \"priority\": \"Low\",\n \"meetingLocation\": \"PhoneNumber/ZoomLink/GoogleMeet/Location\"\n }\n ],\n \"name\": \"30 Mins Call\",\n \"description\": \"30 Minutes Call\",\n \"slug\": \"30-mins-call\",\n \"eventColor\": \"Peacock\",\n \"availability\": {\n \"eventTiming\": {\n \"slotDuration\": 30,\n \"slotInterval\": 30,\n \"slotBuffer\": 0\n },\n \"appointmentInfo\": {\n \"perSlot\": 0,\n \"perDay\": 0\n },\n \"schedule\": {\n \"allowBookingAfter\": 0,\n \"allowBookingAfterUnit\": \"days\",\n \"allowBookingFor\": 0,\n \"allowBookingForUnit\": \"days\"\n },\n \"officeHours\": {\n \"sunday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"monday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"tuesday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"wednesday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"thursday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"friday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"saturday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ]\n }\n },\n \"confirmation\": {\n \"form\": {\n \"customFormId\": \"\",\n \"stickyContact\": false,\n \"stripe\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"chargeDescription\": \"Your will be billed X amount for this appointment\"\n }\n },\n \"notificationAndOther\": {\n \"autoConfirm\": true,\n \"shouldSendAlertEmailsToAssignedMember\": true,\n \"googleInvitationEmails\": false,\n \"allowReschedule\": true,\n \"allowCancellation\": true,\n \"notes\": \"Phone:- {{contact.phone}} Email:- {{contact.email}} Need to make a change to this event? Reschedule:- {{reschedule_link}} Cancel:- {{cancellation_link}}\",\n \"facebookPixelId\": \"\"\n },\n \"formSubmission\": {\n \"type\": \"ThankYouMessage\",\n \"content\": \"https://www.bing.com or Thank you for your appointment request. We will contact you shortly to confirm your request. Please call our office at {{contactMethod}} if you have any questions.\"\n }\n },\n \"appointmentTitle\": \"{{contact.name}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/calendars/services/"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"teamId\": {\n \"message\": \"The team id field is mandatory.\",\n \"rule\": \"required\"\n },\n \"name\": {\n \"message\": \"The name field is mandatory.\",\n \"rule\": \"required\"\n },\n \"description\": {\n \"message\": \"The description field is mandatory.\",\n \"rule\": \"required\"\n },\n \"eventType\": {\n \"message\": \"The event type field is mandatory.\",\n \"rule\": \"required\"\n },\n \"teamMembers\": {\n \"message\": \"The team members field is mandatory.\",\n \"rule\": \"required\"\n },\n \"slug\": {\n \"message\": \"The slug field is mandatory.\",\n \"rule\": \"required\"\n },\n \"appointmentTitle\": {\n \"message\": \"The team members field is mandatory.\",\n \"rule\": \"required\"\n },\n \"eventColor\": {\n \"message\": \"The event color field is mandatory.\",\n \"rule\": \"required\"\n },\n \"availability.eventTiming.slotDuration\": {\n \"message\": \"The availability.eventTiming.slotDuration members field is mandatory.\",\n \"rule\": \"required\"\n },\n \"availability.eventTiming.slotInterval\": {\n \"message\": \"The availability.eventTiming.slotInterval members field is mandatory.\",\n \"rule\": \"required\"\n },\n \"availability.officeHours\": {\n \"message\": \"The availability.officeHours members field is mandatory.\",\n \"rule\": \"required\"\n },\n \"confirmation.notificationAndOther.autoConfirm\": {\n \"message\": \"The confirmation.notificationAndOther.autoConfirm members field is mandatory.\",\n \"rule\": \"required\"\n },\n \"confirmation.notificationAndOther.shouldSendAlertEmailsToAssignedMember\": {\n \"message\": \"The confirmation.notificationAndOther.shouldSendAlertEmailsToAssignedMember members field is mandatory.\",\n \"rule\": \"required\"\n },\n \"confirmation.notificationAndOther.googleInvitationEmails\": {\n \"message\": \"The confirmation.notificationAndOther.googleInvitationEmails members field is mandatory.\",\n \"rule\": \"required\"\n },\n \"confirmation.notificationAndOther.allowReschedule\": {\n \"message\": \"The confirmation.notificationAndOther.allowReschedule members field is mandatory.\",\n \"rule\": \"required\"\n },\n \"confirmation.notificationAndOther.allowCancellation\": {\n \"message\": \"The confirmation.notificationAndOther.allowCancellation members field is mandatory.\",\n \"rule\": \"required\"\n },\n \"confirmation.formSubmission.type\": {\n \"message\": \"The confirmation.formSubmission.type members field is mandatory.\",\n \"rule\": \"required\"\n },\n \"confirmation.formSubmission.content\": {\n \"message\": \"The confirmation.formSubmission.content members field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"c5b6a604-6673-409b-9a72-c103e0b47f71"},{"name":"/v1/calendars/services/:serviceId","id":"663b401e-947c-4b70-a310-ecb551193596","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"teamId\": \"0RXEzw5UVe5oLFm6GQls\",\n \"eventType\": \"RoundRobin_OptimizeForAvailability\",\n \"teamMembers\": [\n {\n \"selected\": true,\n \"userId\": \"0nU7uKSrtT2RVM1KknuF\",\n \"priority\": \"Low\",\n \"meetingLocation\": \"PhoneNumber/ZoomLink/GoogleMeet/Location\"\n },\n {\n \"selected\": true,\n \"userId\": \"0nU7uKSrtT2RVM1KknuF\",\n \"priority\": \"Low\",\n \"meetingLocation\": \"PhoneNumber/ZoomLink/GoogleMeet/Location\"\n }\n ],\n \"name\": \"30 Mins Call\",\n \"description\": \"30 Minutes Call\",\n \"slug\": \"30-mins-call\",\n \"eventColor\": \"Peacock\",\n \"availability\": {\n \"eventTiming\": {\n \"slotDuration\": 30,\n \"slotInterval\": 30,\n \"slotBuffer\": 0\n },\n \"appointmentInfo\": {\n \"perSlot\": 0,\n \"perDay\": 0\n },\n \"schedule\": {\n \"allowBookingAfter\": 0,\n \"allowBookingAfterUnit\": \"days\",\n \"allowBookingFor\": 0,\n \"allowBookingForUnit\": \"days\"\n },\n \"officeHours\": {\n \"sunday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"monday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"tuesday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"wednesday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"thursday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"friday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"saturday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ]\n }\n },\n \"confirmation\": {\n \"form\": {\n \"customFormId\": \"\",\n \"stickyContact\": false,\n \"stripe\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"chargeDescription\": \"Your will be billed X amount for this appointment\"\n }\n },\n \"notificationAndOther\": {\n \"autoConfirm\": true,\n \"shouldSendAlertEmailsToAssignedMember\": true,\n \"googleInvitationEmails\": false,\n \"allowReschedule\": true,\n \"allowCancellation\": true,\n \"notes\": \"Phone:- {{contact.phone}} Email:- {{contact.email}} Need to make a change to this event? Reschedule:- {{reschedule_link}} Cancel:- {{cancellation_link}}\",\n \"facebookPixelId\": \"\"\n },\n \"formSubmission\": {\n \"type\": \"ThankYouMessage\",\n \"content\": \"https://www.bing.com or Thank you for your appointment request. We will contact you shortly to confirm your request. Please call our office at {{contactMethod}} if you have any questions.\"\n }\n },\n \"appointmentTitle\": \"{{contact.name}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/calendars/services/:serviceId","description":"

Update existing service

Required JSON fields in the body

FieldsTypesExampleAllowed Option?
teamIdstringO4qa8K1M6xA4oPXu1b8O
namestringAwsome Service
descriptionstringAwsome description
eventTypestringRoundRobin_OptimizeForAvailability
  • RoundRobin_OptimizeForAvailability
  • RoundRobin_OptimizeForEqualDistribution
teamMembersobbjectSee field info on the teamMembers table
slugstringawsome-service
appointmentTitlestring{{contact.name}}
eventColorstringTomato
  • Banana
  • Basil
  • Blueberry
  • Flamingo
  • Grape
  • Graphite
  • Lavender
  • Peacock
  • Sage
  • Tangerine
  • Tomato
availabilityobjectSee field info on availability table.
confirmationobjectSee field info on confirmation table.

Allowed JSON fields in the body

FieldsTypesExampleAllowed Option
isActivebooleantrue
syncOptionstringoneway
  • oneway
  • twoway
slugstringfirst-calendar

Allowed JSON fields in the teamMembers

FieldsTypesExampleAllowed Optionsis Required?
userIdstringGCs5KuzPqTls7vWclkEVYes
prioritystringHigh
  • High
  • Medium
  • Low
Yes
selectedbooleantrueYes
meetingLocationstringhttps://zoom.us/j/XXXXXXXXXXNo

Allowed JSON fields in the availability

FieldsTypesExampleis Required?
eventTimingobjectSee field info on availability.eventTiming table.Yes
officeHoursobjectSee field info on availability.officeHours table.Yes
appointmentInfoobjectSee field info on availability.appointmentInfo table.No
scheduleobjectSee field info on availability.schedule table.No

Allowed JSON fields in the availability.eventTiming

FieldsTypesExampleAllowed Optionsis Required?
slotDurationnumber30
  • 10
  • 15
  • 20
  • 30
  • 45
  • 60
  • 90
  • 120
  • 180
  • 240
  • 300
  • 360
  • 420
  • 480
Yes
slotIntervalnumber30
  • 10
  • 15
  • 20
  • 30
  • 45
  • 60
  • 90
  • 120
  • 180
  • 240
  • 300
  • 360
  • 420
  • 480
Yes
slotBuffernumber1No

Allowed JSON fields in the availability.appointmentInfo

FieldsTypesExampleis Required?
perSlotnumber1No
perDaynumber5No

Allowed JSON fields in the availability.schedule

FieldsTypesExampleAllowed Optionsis Required?
allowBookingAfternumber1No
allowBookingAfterUnitstringdays
  • hours
  • days
  • weeks
  • months
No
allowBookingFornumber5No
allowBookingForUnitstringdays
  • hours
  • days
  • weeks
  • months
No

Allowed JSON fields in the availability.officeHours

FieldsTypesExampleis Required?
mondayarrayPlease see field info availability.officeHours.days table. include as a array.Yes
tuesdayarrayPlease see field info availability.officeHours.days table. include as a array.Yes
wednesdayarrayPlease see field info availability.officeHours.days table. include as a array.Yes
thursdayarrayPlease see field info availability.officeHours.days table. include as a array.Yes
fridayarrayPlease see field info availability.officeHours.days table. include as a array.Yes

Allowed JSON fields in the availability.officeHours.days

FieldsTypesExampleis Required?
openMinutenumber0Yes
openHournumber8Yes
closeMinutenumber0Yes
closeHournumber17Yes

Allowed JSON fields in the confirmation

FieldsTypesExampleis Required?
formobjectSee field info on confirmation.form table.No
notificationAndOtherobjectSee field info on confirmation.notificationAndOther table.Yes
formSubmissionobjectSee field info on confirmation.formSubmission table.Yes

Allowed JSON fields in the confirmation.form

FieldsTypesExampleis Required?
customFormIdstringjjusM6EOngDExnbo2DbUNo
stickyContactbooleanfalseNo

Allowed JSON fields in the confirmation.notificationAndOther

FieldsTypesExampleis Required?
autoConfirmbooleanfalseYes
shouldSendAlertEmailsToAssignedMemberbooleanfalseYes
googleInvitationEmailsbooleanfalseYes
allowReschedulebooleanfalseYes
allowCancellationbooleanfalseYes
alertEmailstringjohn@deo.comNo
notesstringAwesome NotesNo
facebookPixelIdstringXXXXXXXXXXNo

Allowed JSON fields in the confirmation.formSubmission

FieldsTypesExampleAllowed Optionsis Required?
typestringThankYouMessage
  • ThankYouMessage
  • RedirectURL
Yes
contentstringThank you for your appointment request.Yes

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","calendars","services",":serviceId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"1dac6146-cea8-4f1e-a1f9-5d5b032734d0","description":{"content":"

(Required) Service Id

\n","type":"text/plain"},"type":"any","value":"0RXEzw5UVe5oLFm6GQls","key":"serviceId"}]}},"response":[{"id":"2e71fee3-ff57-4ccf-b898-c69068186d11","name":"Successful response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"teamId\": \"0RXEzw5UVe5oLFm6GQls\",\n \"eventType\": \"RoundRobin_OptimizeForAvailability\",\n \"teamMembers\": [\n {\n \"selected\": true,\n \"userId\": \"0nU7uKSrtT2RVM1KknuF\",\n \"priority\": \"Low\",\n \"meetingLocation\": \"PhoneNumber/ZoomLink/GoogleMeet/Location\"\n },\n {\n \"selected\": true,\n \"userId\": \"0nU7uKSrtT2RVM1KknuF\",\n \"priority\": \"Low\",\n \"meetingLocation\": \"PhoneNumber/ZoomLink/GoogleMeet/Location\"\n }\n ],\n \"name\": \"30 Mins Call\",\n \"description\": \"30 Minutes Call\",\n \"slug\": \"30-mins-call\",\n \"eventColor\": \"Peacock\",\n \"availability\": {\n \"eventTiming\": {\n \"slotDuration\": 30,\n \"slotInterval\": 30,\n \"slotBuffer\": 0\n },\n \"appointmentInfo\": {\n \"perSlot\": 0,\n \"perDay\": 0\n },\n \"schedule\": {\n \"allowBookingAfter\": 0,\n \"allowBookingAfterUnit\": \"days\",\n \"allowBookingFor\": 0,\n \"allowBookingForUnit\": \"days\"\n },\n \"officeHours\": {\n \"sunday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"monday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"tuesday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"wednesday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"thursday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"friday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"saturday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ]\n }\n },\n \"confirmation\": {\n \"form\": {\n \"customFormId\": \"\",\n \"stickyContact\": false,\n \"stripe\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"chargeDescription\": \"Your will be billed X amount for this appointment\"\n }\n },\n \"notificationAndOther\": {\n \"autoConfirm\": true,\n \"shouldSendAlertEmailsToAssignedMember\": true,\n \"googleInvitationEmails\": false,\n \"allowReschedule\": true,\n \"allowCancellation\": true,\n \"notes\": \"Phone:- {{contact.phone}} Email:- {{contact.email}} Need to make a change to this event? Reschedule:- {{reschedule_link}} Cancel:- {{cancellation_link}}\",\n \"facebookPixelId\": \"\"\n },\n \"formSubmission\": {\n \"type\": \"ThankYouMessage\",\n \"content\": \"https://www.bing.com or Thank you for your appointment request. We will contact you shortly to confirm your request. Please call our office at {{contactMethod}} if you have any questions.\"\n }\n },\n \"appointmentTitle\": \"{{contact.name}}\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/calendars/services/:serviceId","host":["https://rest.gohighlevel.com"],"path":["v1","calendars","services",":serviceId"],"variable":[{"key":"serviceId","value":"0RXEzw5UVe5oLFm6GQls","description":"(Required) Service Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"OW59k4IchTgKjIDy3VMO\",\n \"name\": \"Test Service\",\n \"description\": \"Test Service Desc.\",\n \"appointmentTitle\": \"{{contact.name}}\",\n \"meetingLocation\": \"location\",\n \"eventColor\": \"#FF0000\",\n \"teamId\": \"#FF0000\",\n \"linkedCalendars\": {\n \"google\": {\n \"id\": \"adipisicing laboris veniam \",\n \"name\": \"ipsum fugiat ut\"\n },\n \"clio\": {\n \"id\": \"esse non adip\",\n \"name\": \"tempor Excepteur\"\n },\n \"drchrono\": {\n \"id\": \"magna in sunt veniam\",\n \"name\": \"ut sed adipisicing nisi\"\n }\n },\n \"syncOption\": \"oneway\",\n \"teamMembers\": [\n {\n \"userId\": \"\",\n \"priority\": 0,\n \"selected\": false,\n \"meetingLocation\": \"https://zoom.us\"\n },\n {\n \"userId\": \"\",\n \"priority\": 0,\n \"selected\": false,\n \"meetingLocation\": \"https://zoom.us\"\n }\n ],\n \"availability\": {\n \"eventTiming\": {\n \"slotDuration\": 30,\n \"slotInterval\": 30,\n \"slotBuffer\": 0\n },\n \"appointmentInfo\": {\n \"perSlot\": 1,\n \"perDay\": 8\n },\n \"schedule\": {\n \"allowBookingAfter\": 1,\n \"allowBookingAfterUnit\": \"Hours\",\n \"allowBookingFor\": 8,\n \"allowBookingForUnit\": \"Hours\"\n },\n \"officeHours\": {\n \"monday\": [\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n },\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n }\n ],\n \"tuesday\": [\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n },\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n }\n ],\n \"wednesday\": [\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n },\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n }\n ],\n \"thursday\": [\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n },\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n }\n ],\n \"friday\": [\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n },\n {\n \"openMinute\": 0,\n \"closeMinute\": 0,\n \"closeHour\": 17,\n \"openHour\": 8\n }\n ]\n }\n },\n \"confirmation\": {\n \"form\": {\n \"customFormId\": \"jjusM6EOngDExnbo2DbU\",\n \"stickyContact\": false\n },\n \"notificationAndOther\": {\n \"alertEmail\": \"dolor elit\",\n \"hasAutoConfirm\": false,\n \"hasGoogleSendInvitationEmail\": false,\n \"hasAllowReschedule\": false,\n \"hasAllowCancellation\": false,\n \"hasSendEmailToAssignedMember\": false,\n \"notes\": \"\",\n \"facebookPixelId\": \"\",\n \"customCode\": \"\"\n },\n \"formSubmission\": {\n \"type\": \"ThankYouMessage\",\n \"content\": \"\"\n }\n }\n}"},{"id":"868f2688-a5bb-4164-af2f-f9081cb3adad","name":"Bad Request. please contact support!","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"teamId\": \"0RXEzw5UVe5oLFm6GQls\",\n \"eventType\": \"RoundRobin_OptimizeForAvailability\",\n \"teamMembers\": [\n {\n \"selected\": true,\n \"userId\": \"0nU7uKSrtT2RVM1KknuF\",\n \"priority\": \"Low\",\n \"meetingLocation\": \"PhoneNumber/ZoomLink/GoogleMeet/Location\"\n },\n {\n \"selected\": true,\n \"userId\": \"0nU7uKSrtT2RVM1KknuF\",\n \"priority\": \"Low\",\n \"meetingLocation\": \"PhoneNumber/ZoomLink/GoogleMeet/Location\"\n }\n ],\n \"name\": \"30 Mins Call\",\n \"description\": \"30 Minutes Call\",\n \"slug\": \"30-mins-call\",\n \"eventColor\": \"Peacock\",\n \"availability\": {\n \"eventTiming\": {\n \"slotDuration\": 30,\n \"slotInterval\": 30,\n \"slotBuffer\": 0\n },\n \"appointmentInfo\": {\n \"perSlot\": 0,\n \"perDay\": 0\n },\n \"schedule\": {\n \"allowBookingAfter\": 0,\n \"allowBookingAfterUnit\": \"days\",\n \"allowBookingFor\": 0,\n \"allowBookingForUnit\": \"days\"\n },\n \"officeHours\": {\n \"sunday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"monday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"tuesday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"wednesday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"thursday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"friday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"saturday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ]\n }\n },\n \"confirmation\": {\n \"form\": {\n \"customFormId\": \"\",\n \"stickyContact\": false,\n \"stripe\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"chargeDescription\": \"Your will be billed X amount for this appointment\"\n }\n },\n \"notificationAndOther\": {\n \"autoConfirm\": true,\n \"shouldSendAlertEmailsToAssignedMember\": true,\n \"googleInvitationEmails\": false,\n \"allowReschedule\": true,\n \"allowCancellation\": true,\n \"notes\": \"Phone:- {{contact.phone}} Email:- {{contact.email}} Need to make a change to this event? Reschedule:- {{reschedule_link}} Cancel:- {{cancellation_link}}\",\n \"facebookPixelId\": \"\"\n },\n \"formSubmission\": {\n \"type\": \"ThankYouMessage\",\n \"content\": \"https://www.bing.com or Thank you for your appointment request. We will contact you shortly to confirm your request. Please call our office at {{contactMethod}} if you have any questions.\"\n }\n },\n \"appointmentTitle\": \"{{contact.name}}\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/calendars/services/:serviceId","host":["https://rest.gohighlevel.com"],"path":["v1","calendars","services",":serviceId"],"variable":[{"key":"serviceId","value":"0RXEzw5UVe5oLFm6GQls","description":"(Required) Service Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"42378be7-4895-4019-8ebc-2dfd3c5cd670","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"teamId\": \"0RXEzw5UVe5oLFm6GQls\",\n \"eventType\": \"RoundRobin_OptimizeForAvailability\",\n \"teamMembers\": [\n {\n \"selected\": true,\n \"userId\": \"0nU7uKSrtT2RVM1KknuF\",\n \"priority\": \"Low\",\n \"meetingLocation\": \"PhoneNumber/ZoomLink/GoogleMeet/Location\"\n },\n {\n \"selected\": true,\n \"userId\": \"0nU7uKSrtT2RVM1KknuF\",\n \"priority\": \"Low\",\n \"meetingLocation\": \"PhoneNumber/ZoomLink/GoogleMeet/Location\"\n }\n ],\n \"name\": \"30 Mins Call\",\n \"description\": \"30 Minutes Call\",\n \"slug\": \"30-mins-call\",\n \"eventColor\": \"Peacock\",\n \"availability\": {\n \"eventTiming\": {\n \"slotDuration\": 30,\n \"slotInterval\": 30,\n \"slotBuffer\": 0\n },\n \"appointmentInfo\": {\n \"perSlot\": 0,\n \"perDay\": 0\n },\n \"schedule\": {\n \"allowBookingAfter\": 0,\n \"allowBookingAfterUnit\": \"days\",\n \"allowBookingFor\": 0,\n \"allowBookingForUnit\": \"days\"\n },\n \"officeHours\": {\n \"sunday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"monday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"tuesday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"wednesday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"thursday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"friday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"saturday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ]\n }\n },\n \"confirmation\": {\n \"form\": {\n \"customFormId\": \"\",\n \"stickyContact\": false,\n \"stripe\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"chargeDescription\": \"Your will be billed X amount for this appointment\"\n }\n },\n \"notificationAndOther\": {\n \"autoConfirm\": true,\n \"shouldSendAlertEmailsToAssignedMember\": true,\n \"googleInvitationEmails\": false,\n \"allowReschedule\": true,\n \"allowCancellation\": true,\n \"notes\": \"Phone:- {{contact.phone}} Email:- {{contact.email}} Need to make a change to this event? Reschedule:- {{reschedule_link}} Cancel:- {{cancellation_link}}\",\n \"facebookPixelId\": \"\"\n },\n \"formSubmission\": {\n \"type\": \"ThankYouMessage\",\n \"content\": \"https://www.bing.com or Thank you for your appointment request. We will contact you shortly to confirm your request. Please call our office at {{contactMethod}} if you have any questions.\"\n }\n },\n \"appointmentTitle\": \"{{contact.name}}\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/calendars/services/:serviceId","host":["https://rest.gohighlevel.com"],"path":["v1","calendars","services",":serviceId"],"variable":[{"key":"serviceId","value":"0RXEzw5UVe5oLFm6GQls","description":"(Required) Service Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"81823370-ca7a-4028-9745-5132a8135b97","name":"Unprocessable Entity","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"teamId\": \"0RXEzw5UVe5oLFm6GQls\",\n \"eventType\": \"RoundRobin_OptimizeForAvailability\",\n \"teamMembers\": [\n {\n \"selected\": true,\n \"userId\": \"0nU7uKSrtT2RVM1KknuF\",\n \"priority\": \"Low\",\n \"meetingLocation\": \"PhoneNumber/ZoomLink/GoogleMeet/Location\"\n },\n {\n \"selected\": true,\n \"userId\": \"0nU7uKSrtT2RVM1KknuF\",\n \"priority\": \"Low\",\n \"meetingLocation\": \"PhoneNumber/ZoomLink/GoogleMeet/Location\"\n }\n ],\n \"name\": \"30 Mins Call\",\n \"description\": \"30 Minutes Call\",\n \"slug\": \"30-mins-call\",\n \"eventColor\": \"Peacock\",\n \"availability\": {\n \"eventTiming\": {\n \"slotDuration\": 30,\n \"slotInterval\": 30,\n \"slotBuffer\": 0\n },\n \"appointmentInfo\": {\n \"perSlot\": 0,\n \"perDay\": 0\n },\n \"schedule\": {\n \"allowBookingAfter\": 0,\n \"allowBookingAfterUnit\": \"days\",\n \"allowBookingFor\": 0,\n \"allowBookingForUnit\": \"days\"\n },\n \"officeHours\": {\n \"sunday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"monday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"tuesday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"wednesday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"thursday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"friday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ],\n \"saturday\": [\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n },\n {\n \"openHour\": 8,\n \"openMinute\": 0,\n \"closeHour\": 17,\n \"closeMinute\": 0\n }\n ]\n }\n },\n \"confirmation\": {\n \"form\": {\n \"customFormId\": \"\",\n \"stickyContact\": false,\n \"stripe\": {\n \"amount\": 0,\n \"currency\": \"USD\",\n \"chargeDescription\": \"Your will be billed X amount for this appointment\"\n }\n },\n \"notificationAndOther\": {\n \"autoConfirm\": true,\n \"shouldSendAlertEmailsToAssignedMember\": true,\n \"googleInvitationEmails\": false,\n \"allowReschedule\": true,\n \"allowCancellation\": true,\n \"notes\": \"Phone:- {{contact.phone}} Email:- {{contact.email}} Need to make a change to this event? Reschedule:- {{reschedule_link}} Cancel:- {{cancellation_link}}\",\n \"facebookPixelId\": \"\"\n },\n \"formSubmission\": {\n \"type\": \"ThankYouMessage\",\n \"content\": \"https://www.bing.com or Thank you for your appointment request. We will contact you shortly to confirm your request. Please call our office at {{contactMethod}} if you have any questions.\"\n }\n },\n \"appointmentTitle\": \"{{contact.name}}\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/calendars/services/:serviceId","host":["https://rest.gohighlevel.com"],"path":["v1","calendars","services",":serviceId"],"variable":[{"key":"serviceId","value":"0RXEzw5UVe5oLFm6GQls","description":"(Required) Service Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"teamId\": {\n \"message\": \"The team id field is mandatory.\",\n \"rule\": \"required\"\n },\n \"name\": {\n \"message\": \"The name field is mandatory.\",\n \"rule\": \"required\"\n },\n \"description\": {\n \"message\": \"The description field is mandatory.\",\n \"rule\": \"required\"\n },\n \"eventType\": {\n \"message\": \"The event type field is mandatory.\",\n \"rule\": \"required\"\n },\n \"teamMembers\": {\n \"message\": \"The team members field is mandatory.\",\n \"rule\": \"required\"\n },\n \"slug\": {\n \"message\": \"The slug field is mandatory.\",\n \"rule\": \"required\"\n },\n \"appointmentTitle\": {\n \"message\": \"The team members field is mandatory.\",\n \"rule\": \"required\"\n },\n \"eventColor\": {\n \"message\": \"The event color field is mandatory.\",\n \"rule\": \"required\"\n },\n \"availability.eventTiming.slotDuration\": {\n \"message\": \"The availability.eventTiming.slotDuration members field is mandatory.\",\n \"rule\": \"required\"\n },\n \"availability.eventTiming.slotInterval\": {\n \"message\": \"The availability.eventTiming.slotInterval members field is mandatory.\",\n \"rule\": \"required\"\n },\n \"availability.officeHours\": {\n \"message\": \"The availability.officeHours members field is mandatory.\",\n \"rule\": \"required\"\n },\n \"confirmation.notificationAndOther.autoConfirm\": {\n \"message\": \"The confirmation.notificationAndOther.autoConfirm members field is mandatory.\",\n \"rule\": \"required\"\n },\n \"confirmation.notificationAndOther.shouldSendAlertEmailsToAssignedMember\": {\n \"message\": \"The confirmation.notificationAndOther.shouldSendAlertEmailsToAssignedMember members field is mandatory.\",\n \"rule\": \"required\"\n },\n \"confirmation.notificationAndOther.googleInvitationEmails\": {\n \"message\": \"The confirmation.notificationAndOther.googleInvitationEmails members field is mandatory.\",\n \"rule\": \"required\"\n },\n \"confirmation.notificationAndOther.allowReschedule\": {\n \"message\": \"The confirmation.notificationAndOther.allowReschedule members field is mandatory.\",\n \"rule\": \"required\"\n },\n \"confirmation.notificationAndOther.allowCancellation\": {\n \"message\": \"The confirmation.notificationAndOther.allowCancellation members field is mandatory.\",\n \"rule\": \"required\"\n },\n \"confirmation.formSubmission.type\": {\n \"message\": \"The confirmation.formSubmission.type members field is mandatory.\",\n \"rule\": \"required\"\n },\n \"confirmation.formSubmission.content\": {\n \"message\": \"The confirmation.formSubmission.content members field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"663b401e-947c-4b70-a310-ecb551193596"},{"name":"/v1/calendars/services/:serviceId","id":"5735e248-408b-4595-968b-f774fcc2a784","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"DELETE","header":[],"url":"https://rest.gohighlevel.com/v1/calendars/services/:serviceId","description":"

Delete Service.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","calendars","services",":serviceId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"20926965-21a7-42a9-bc14-766cb7b0d8e0","description":{"content":"

(Required) Service Id

\n","type":"text/plain"},"type":"any","value":"0RXEzw5UVe5oLFm6GQls","key":"serviceId"}]}},"response":[{"id":"7b21c9be-4042-41a3-93eb-0e973b573913","name":"Successful response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/calendars/services/:serviceId","host":["https://rest.gohighlevel.com"],"path":["v1","calendars","services",":serviceId"],"variable":[{"key":"serviceId","value":"0RXEzw5UVe5oLFm6GQls","description":"(Required) Service Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"c9776af2-49c4-4b5a-81f0-eaaa40b480a1","name":"Bad Request. please contact support!","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/calendars/services/:serviceId","host":["https://rest.gohighlevel.com"],"path":["v1","calendars","services",":serviceId"],"variable":[{"key":"serviceId","value":"0RXEzw5UVe5oLFm6GQls","description":"(Required) Service Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"f57c1961-88e2-4c6b-9861-e4712954a286","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/calendars/services/:serviceId","host":["https://rest.gohighlevel.com"],"path":["v1","calendars","services",":serviceId"],"variable":[{"key":"serviceId","value":"0RXEzw5UVe5oLFm6GQls","description":"(Required) Service Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"2ab1a444-faaa-44ec-af3e-ae5aebcdfe8d","name":"Unprocessable Entity","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/calendars/services/:serviceId","host":["https://rest.gohighlevel.com"],"path":["v1","calendars","services",":serviceId"],"variable":[{"key":"serviceId","value":"0RXEzw5UVe5oLFm6GQls","description":"(Required) Service Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": {\n \"message\": \"The contact id is invalid.\",\n \"rule\": \"invalid\"\n }\n}"}],"_postman_id":"5735e248-408b-4595-968b-f774fcc2a784"}],"id":"75e316c2-5591-4efb-8187-f9a4a8356fe8","_postman_id":"75e316c2-5591-4efb-8187-f9a4a8356fe8","description":"","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","name":"GoHighLevel API V1.1.20","type":"collection"}}},{"name":"Appointment","item":[{"name":"/v1/appointments/slots","id":"32b084c2-c54a-4210-9ee9-2868cdab7b8c","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/appointments/slots?calendarId=CVokAlI8fgw4WYWoCtQz&startDate=1598898600000&endDate=1601490599999&timezone=America/Chihuahua&userId=082goXVW3lIExEQPOnd3","description":"

Get free slots.

Required fields in the query

FieldsTypesExample
calendarIdstringCVokAlI8fgw4WYWoCtQz
startDateintegerepoch timestamp. for ex: 1548898600000
endDateintegerepoch timestamp. for ex: 1601490599999

Allowed field in the query

FieldsTypesExample
userIdstring082goXVW3lIExEQPOnd3
timezonestringAmerica/Chihuahua

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","appointments","slots"],"host":["https://rest.gohighlevel.com"],"query":[{"description":{"content":"

(Required) Calendar Id

\n","type":"text/plain"},"key":"calendarId","value":"CVokAlI8fgw4WYWoCtQz"},{"description":{"content":"

(Required) epoch timestamp

\n","type":"text/plain"},"key":"startDate","value":"1598898600000"},{"description":{"content":"

(Required) epoch timestamp

\n","type":"text/plain"},"key":"endDate","value":"1601490599999"},{"description":{"content":"

Timezone

\n","type":"text/plain"},"key":"timezone","value":"America/Chihuahua"},{"description":{"content":"

User Id

\n","type":"text/plain"},"key":"userId","value":"082goXVW3lIExEQPOnd3"}],"variable":[]}},"response":[{"id":"6b04e0b3-46e7-46a6-9c21-8fb804bb8968","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/appointments/slots?calendarId=CVokAlI8fgw4WYWoCtQz&startDate=1598898600000&endDate=1601490599999&timezone=America/Chihuahua&userId=082goXVW3lIExEQPOnd3","host":["https://rest.gohighlevel.com"],"path":["v1","appointments","slots"],"query":[{"key":"calendarId","value":"CVokAlI8fgw4WYWoCtQz"},{"key":"startDate","value":"1598898600000"},{"key":"endDate","value":"1601490599999"},{"key":"timezone","value":"America/Chihuahua"},{"key":"userId","value":"082goXVW3lIExEQPOnd3"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"_dates_\": {\n \"slots\": [\n \"2020-09-04T08:00:00+05:30\",\n \"2020-09-04T08:00:00+05:30\"\n ]\n }\n}"},{"id":"fa2d6a12-2b47-4a09-9b9e-35439e7714f4","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/appointments/slots?calendarId=CVokAlI8fgw4WYWoCtQz&startDate=1598898600000&endDate=1601490599999&timezone=America/Chihuahua&userId=082goXVW3lIExEQPOnd3","host":["https://rest.gohighlevel.com"],"path":["v1","appointments","slots"],"query":[{"key":"calendarId","value":"CVokAlI8fgw4WYWoCtQz"},{"key":"startDate","value":"1598898600000"},{"key":"endDate","value":"1601490599999"},{"key":"timezone","value":"America/Chihuahua"},{"key":"userId","value":"082goXVW3lIExEQPOnd3"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"682b08e8-ef43-4765-b855-bc18fe85d9fc","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/appointments/slots?calendarId=CVokAlI8fgw4WYWoCtQz&startDate=1598898600000&endDate=1601490599999&timezone=America/Chihuahua&userId=082goXVW3lIExEQPOnd3","host":["https://rest.gohighlevel.com"],"path":["v1","appointments","slots"],"query":[{"key":"calendarId","value":"CVokAlI8fgw4WYWoCtQz"},{"key":"startDate","value":"1598898600000"},{"key":"endDate","value":"1601490599999"},{"key":"timezone","value":"America/Chihuahua"},{"key":"userId","value":"082goXVW3lIExEQPOnd3"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"ba8d7acf-0fba-458f-ae79-f7a7fa56eb89","name":"Unprocessable Entity","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/appointments/slots?calendarId=CVokAlI8fgw4WYWoCtQz&startDate=1598898600000&endDate=1601490599999&timezone=America/Chihuahua&userId=082goXVW3lIExEQPOnd3","host":["https://rest.gohighlevel.com"],"path":["v1","appointments","slots"],"query":[{"key":"calendarId","value":"CVokAlI8fgw4WYWoCtQz"},{"key":"startDate","value":"1598898600000"},{"key":"endDate","value":"1601490599999"},{"key":"timezone","value":"America/Chihuahua"},{"key":"userId","value":"082goXVW3lIExEQPOnd3"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"calendarId\": {\n \"message\": \"The calendar id field is mandatory.\",\n \"rule\": \"required\"\n },\n \"startDate\": {\n \"message\": \"The start date field is mandatory.\",\n \"rule\": \"required\"\n },\n \"endDate\": {\n \"message\": \"The end date field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"32b084c2-c54a-4210-9ee9-2868cdab7b8c"},{"name":"/v1/appointments/","id":"62d7a834-61d9-4b78-b5bd-c79c19c2e2d0","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/appointments/?startDate=1548898600000&endDate=1601490599999&userId=082goXVW3lIExEQPOnd3&calendarId=0nU7uKSrtT2RVM1KknuF&teamId=O4qa8K1M6xA4oPXu1b8O&includeAll=true","description":"

Get all booked events.

Required fields in the query

FieldsTypesExample
startDateintegerepoch timestamp. for ex: 1548898600000
endDateintegerepoch timestamp. for ex: 1601490599999
userId(or calendarId or teamId)string082goXVW3lIExEQPOnd3
calendarId(or userId or teamId)string0nU7uKSrtT2RVM1KknuF
teamId(or userId or calendarId)stringO4qa8K1M6xA4oPXu1b8O

Allowed field in the query

FieldsTypesExample
includeAllbooleanInclude contact and more data. for ex: true

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","appointments",""],"host":["https://rest.gohighlevel.com"],"query":[{"description":{"content":"

(Required) epoch timestamp

\n","type":"text/plain"},"key":"startDate","value":"1548898600000"},{"description":{"content":"

(Required) epoch timestamp

\n","type":"text/plain"},"key":"endDate","value":"1601490599999"},{"description":{"content":"

User Id

\n","type":"text/plain"},"key":"userId","value":"082goXVW3lIExEQPOnd3"},{"description":{"content":"

Calendar Id

\n","type":"text/plain"},"key":"calendarId","value":"0nU7uKSrtT2RVM1KknuF"},{"description":{"content":"

Team Id

\n","type":"text/plain"},"key":"teamId","value":"O4qa8K1M6xA4oPXu1b8O"},{"description":{"content":"

Include contact and more data.

\n","type":"text/plain"},"key":"includeAll","value":"true"}],"variable":[]}},"response":[{"id":"d5e4ae65-0ccf-4ded-a4df-0a5e3118379d","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/appointments/?startDate=1548898600000&endDate=1601490599999&userId=082goXVW3lIExEQPOnd3&calendarId=0nU7uKSrtT2RVM1KknuF&teamId=O4qa8K1M6xA4oPXu1b8O&includeAll=true","host":["https://rest.gohighlevel.com"],"path":["v1","appointments",""],"query":[{"key":"startDate","value":"1548898600000"},{"key":"endDate","value":"1601490599999"},{"key":"userId","value":"082goXVW3lIExEQPOnd3"},{"key":"calendarId","value":"0nU7uKSrtT2RVM1KknuF"},{"key":"teamId","value":"O4qa8K1M6xA4oPXu1b8O"},{"key":"includeAll","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"appointments\": [\n {\n \"id\": \"EaALh02zfPo8VB3JOnpq\",\n \"userId\": \"GCs5KuzPqTls7vWclkEV\",\n \"calendarProviderId\": \"0nU7uKSrtT2RVM1KknuF\",\n \"calendarId\": \"9qFx5qCKr3jIdBw0DiqB\",\n \"contactId\": \"v1kbP2GBSZq6yzRkh7KT\",\n \"calendarServiceId\": \"CVokAlI8fgw4WYWoCtQz\",\n \"isRecurring\": false,\n \"status\": \"booked\",\n \"appoinmentStatus\": \"confirmed\",\n \"title\": \"Calendar Standup\",\n \"locationId\": \"C2QujeCh8ZnC7al2InWR\",\n \"startTime\": \"2020-07-22T16:00:00+05:30\",\n \"endTime\": \"2020-07-22T16:30:00+05:30\",\n \"selectedTimezone\": \"Asia/Calcutta\",\n \"contact\": {\n \"id\": \"ocQHyuzHvysMo5N5VsXc\",\n \"locationId\": \"C2QujeCh8ZnC7al2InWR\",\n \"email\": \"JohnDeo@gmail.com\",\n \"emailLowerCase\": \"johndeo@gmail.com\",\n \"fingerprint\": \"91f4f0e0-e2dd-11ea-9b16-53b2d72e8a24\",\n \"timezone\": \"Asia/Calcutta\",\n \"country\": \"DE\",\n \"customField\": [\n {\n \"id\": \"MgobCB14YMVKuE4Ka8p1\",\n \"value\": \"tempor in ut\"\n },\n {\n \"id\": \"MgobCB14YMVKuE4Ka8p1\",\n \"value\": \"Duis\"\n }\n ],\n \"tags\": [\n \"nulla\",\n \"minim est\"\n ],\n \"__moreField__\": \"id ex nulla\"\n }\n },\n {\n \"id\": \"EaALh02zfPo8VB3JOnpq\",\n \"userId\": \"GCs5KuzPqTls7vWclkEV\",\n \"calendarProviderId\": \"0nU7uKSrtT2RVM1KknuF\",\n \"calendarId\": \"9qFx5qCKr3jIdBw0DiqB\",\n \"contactId\": \"v1kbP2GBSZq6yzRkh7KT\",\n \"calendarServiceId\": \"CVokAlI8fgw4WYWoCtQz\",\n \"isRecurring\": false,\n \"status\": \"booked\",\n \"appoinmentStatus\": \"confirmed\",\n \"title\": \"Calendar Standup\",\n \"locationId\": \"C2QujeCh8ZnC7al2InWR\",\n \"startTime\": \"2020-07-22T16:00:00+05:30\",\n \"endTime\": \"2020-07-22T16:30:00+05:30\",\n \"selectedTimezone\": \"Asia/Calcutta\",\n \"contact\": {\n \"id\": \"ocQHyuzHvysMo5N5VsXc\",\n \"locationId\": \"C2QujeCh8ZnC7al2InWR\",\n \"email\": \"JohnDeo@gmail.com\",\n \"emailLowerCase\": \"johndeo@gmail.com\",\n \"fingerprint\": \"91f4f0e0-e2dd-11ea-9b16-53b2d72e8a24\",\n \"timezone\": \"Asia/Calcutta\",\n \"country\": \"DE\",\n \"customField\": [\n {\n \"id\": \"MgobCB14YMVKuE4Ka8p1\",\n \"value\": \"adipisicing eu\"\n },\n {\n \"id\": \"MgobCB14YMVKuE4Ka8p1\",\n \"value\": \"nostrud\"\n }\n ],\n \"tags\": [\n \"in voluptate\",\n \"id culpa sit ad dolore\"\n ],\n \"__moreField__\": \"no\"\n }\n }\n ]\n}"},{"id":"6803cae7-7f43-4f73-b195-32a0237e3d33","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/appointments/?startDate=1548898600000&endDate=1601490599999&userId=082goXVW3lIExEQPOnd3&calendarId=0nU7uKSrtT2RVM1KknuF&teamId=O4qa8K1M6xA4oPXu1b8O&includeAll=true","host":["https://rest.gohighlevel.com"],"path":["v1","appointments",""],"query":[{"key":"startDate","value":"1548898600000"},{"key":"endDate","value":"1601490599999"},{"key":"userId","value":"082goXVW3lIExEQPOnd3"},{"key":"calendarId","value":"0nU7uKSrtT2RVM1KknuF"},{"key":"teamId","value":"O4qa8K1M6xA4oPXu1b8O"},{"key":"includeAll","value":"true"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"9390e61e-4a09-47d0-b358-d111d17e2e4b","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/appointments/?startDate=1548898600000&endDate=1601490599999&userId=082goXVW3lIExEQPOnd3&calendarId=0nU7uKSrtT2RVM1KknuF&teamId=O4qa8K1M6xA4oPXu1b8O&includeAll=true","host":["https://rest.gohighlevel.com"],"path":["v1","appointments",""],"query":[{"key":"startDate","value":"1548898600000"},{"key":"endDate","value":"1601490599999"},{"key":"userId","value":"082goXVW3lIExEQPOnd3"},{"key":"calendarId","value":"0nU7uKSrtT2RVM1KknuF"},{"key":"teamId","value":"O4qa8K1M6xA4oPXu1b8O"},{"key":"includeAll","value":"true"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"afc85ca7-d785-45c3-b60e-75bb45e721e8","name":"Unprocessable Entity","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/appointments/?startDate=1548898600000&endDate=1601490599999&userId=082goXVW3lIExEQPOnd3&calendarId=0nU7uKSrtT2RVM1KknuF&teamId=O4qa8K1M6xA4oPXu1b8O&includeAll=true","host":["https://rest.gohighlevel.com"],"path":["v1","appointments",""],"query":[{"key":"startDate","value":"1548898600000"},{"key":"endDate","value":"1601490599999"},{"key":"userId","value":"082goXVW3lIExEQPOnd3"},{"key":"calendarId","value":"0nU7uKSrtT2RVM1KknuF"},{"key":"teamId","value":"O4qa8K1M6xA4oPXu1b8O"},{"key":"includeAll","value":"true"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"startDate\": {\n \"message\": \"The start date field is mandatory.\",\n \"rule\": \"required\"\n },\n \"endDate\": {\n \"message\": \"The end date field is mandatory.\",\n \"rule\": \"required\"\n },\n \"userId or calendarProviderId\": {\n \"message\": \"The user id or calendar provider id field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"62d7a834-61d9-4b78-b5bd-c79c19c2e2d0"},{"name":"/v1/appointments/","id":"1e0867c3-69da-4240-9427-e1286b79472f","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"calendarId\": \"CVokAlI8fgw4WYWoCtQz\",\n \"selectedTimezone\": \"Asia/Calcutta\",\n \"selectedSlot\": \"2021-06-23T03:30:00+05:30\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+18887324197\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/appointments/","description":"

Booking Appoinment.

HL Appointments API provides several different ways the endpoints can be leveraged, You can examine its application depending on any of the following use cases:

Use case #1: Schedule Appointments

This predominantly focuses on consumer facing online booking applications. To be able to use it effectively, consider the following parameters during your set-up.

Required JSON fields in the body

FieldsTypesExample
email(or phone)stringjohndeo@gmail.com
phone(or email)string+1 888-888-8888
selectedSlotdatetime2021-02-05T11:00:00+05:30
selectedTimezonestringAsia/Calcutta
calendarIdstringJ37gEVtdFMRYVQWPdXIc

Allowed JSON fields in the body

FieldsTypesExample
firstNamestringJohn
lastNamestringDeo
namestringJohn Deo
titlestringBest Event
address1longTonkawa Trail W
citystringAustin
statestringTexas
websitestring(url)https://www.google.com
__custome_field_id__string/arrayTest
calendarNoteslongBooked from public api

Use case #2: Block Off Time (Event Blocks)

This focuses specifically on actions surrounding internal applications such as posting a custom event block availability within your own application. While its application covers a range of different scenarios, you can use the following parameters during your set-up.

Required JSON fields in the body

FieldsTypesExample
selectedSlotdatetime2021-02-10T10:00:00Z
endAtdatetime2021-02-12T10:00:00Z
calendarId/userIdstringJ37gEVtdFMRYVQWPdXIc

Allowed JSON fields in the body

FieldsTypesExample
titlestringBlocking Event

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","appointments",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[]}},"response":[{"id":"c1376a64-1c67-4e7a-bc2f-9eab9b9167d1","name":"Successful response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"calendarId\": \"CVokAlI8fgw4WYWoCtQz\",\n \"selectedTimezone\": \"Asia/Calcutta\",\n \"selectedSlot\": \"2021-06-23T03:30:00+05:30\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+18887324197\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/appointments/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"004B1SpcAvh3s9E3rqk8\",\n \"contactId\": \"0007BWpSzSwfiuSl0tR2\",\n \"contact\": {\n \"id\": \"0007BWpSzSwfiuSl0tR2\",\n \"locationId\": \"C2QujeCh8ZnC7al2InWR\",\n \"email\": \"JohnDeo@gmail.com\",\n \"emailLowerCase\": \"johndeo@gmail.com\",\n \"fingerprint\": \"91f4f0e0-e2dd-11ea-9b16-53b2d72e8a24\",\n \"timezone\": \"Asia/Calcutta\",\n \"country\": \"DE\",\n \"customField\": [\n {\n \"id\": \"MgobCB14YMVKuE4Ka8p1\",\n \"value\": \"anim esse\"\n },\n {\n \"id\": \"MgobCB14YMVKuE4Ka8p1\",\n \"value\": \"culpa anim nulla Ut\"\n }\n ],\n \"__moreField__\": \"sin\"\n }\n}"},{"id":"bf85deff-3f0f-4b63-a031-64e3caa43271","name":"Bad Request. please contact support!","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"calendarId\": \"CVokAlI8fgw4WYWoCtQz\",\n \"selectedTimezone\": \"Asia/Calcutta\",\n \"selectedSlot\": \"2021-06-23T03:30:00+05:30\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+18887324197\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/appointments/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"01a831f4-aa88-4d6c-8a45-a5f4cb90e4c6","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"calendarId\": \"CVokAlI8fgw4WYWoCtQz\",\n \"selectedTimezone\": \"Asia/Calcutta\",\n \"selectedSlot\": \"2021-06-23T03:30:00+05:30\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+18887324197\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/appointments/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"99928933-ca13-454a-a9b5-66ffb32e541b","name":"Unprocessable Entity","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"calendarId\": \"CVokAlI8fgw4WYWoCtQz\",\n \"selectedTimezone\": \"Asia/Calcutta\",\n \"selectedSlot\": \"2021-06-23T03:30:00+05:30\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+18887324197\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/appointments/"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"calendarId\": {\n \"message\": \"The calendar id field is mandatory.\",\n \"rule\": \"required\"\n },\n \"selectedSlot\": {\n \"message\": \"The selected slot field is mandatory.\",\n \"rule\": \"required\"\n },\n \"selectedTimezone\": {\n \"message\": \"The selected timezone field is mandatory.\",\n \"rule\": \"required\"\n },\n \"email or phone\": {\n \"message\": \"The email or phone field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"1e0867c3-69da-4240-9427-e1286b79472f"},{"name":"/v1/appointments/:appointmentId","id":"52afdbbd-8558-4c2d-bc0f-fc1f88c82503","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/appointments/:appointmentId","description":"

Get appointment by id.


Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","appointments",":appointmentId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"442dbf20-0691-4624-b1bf-44ddd5829113","description":{"content":"

(Required) Appointment Id

\n","type":"text/plain"},"type":"any","value":"004B1SpcAvh3s9E3rqk8","key":"appointmentId"}]}},"response":[{"id":"53af1a46-9a04-48b1-99c9-b252b863eba6","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/appointments/:appointmentId","host":["https://rest.gohighlevel.com"],"path":["v1","appointments",":appointmentId"],"variable":[{"key":"appointmentId","value":"004B1SpcAvh3s9E3rqk8","description":"(Required) Appointment Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"EaALh02zfPo8VB3JOnpq\",\n \"userId\": \"GCs5KuzPqTls7vWclkEV\",\n \"calendarProviderId\": \"0nU7uKSrtT2RVM1KknuF\",\n \"calendarId\": \"9qFx5qCKr3jIdBw0DiqB\",\n \"contactId\": \"v1kbP2GBSZq6yzRkh7KT\",\n \"calendarServiceId\": \"CVokAlI8fgw4WYWoCtQz\",\n \"isRecurring\": false,\n \"status\": \"booked\",\n \"appoinmentStatus\": \"confirmed\",\n \"title\": \"Calendar Standup\",\n \"locationId\": \"C2QujeCh8ZnC7al2InWR\",\n \"startTime\": \"2020-07-22T16:00:00+05:30\",\n \"endTime\": \"2020-07-22T16:30:00+05:30\",\n \"selectedTimezone\": \"Asia/Calcutta\",\n \"contact\": {\n \"id\": \"ocQHyuzHvysMo5N5VsXc\",\n \"locationId\": \"C2QujeCh8ZnC7al2InWR\",\n \"email\": \"JohnDeo@gmail.com\",\n \"emailLowerCase\": \"johndeo@gmail.com\",\n \"fingerprint\": \"91f4f0e0-e2dd-11ea-9b16-53b2d72e8a24\",\n \"timezone\": \"Asia/Calcutta\",\n \"country\": \"DE\",\n \"customField\": [\n {\n \"id\": \"MgobCB14YMVKuE4Ka8p1\",\n \"value\": \"sit adipisicing\"\n },\n {\n \"id\": \"MgobCB14YMVKuE4Ka8p1\",\n \"value\": \"minim consequa\"\n }\n ],\n \"tags\": [\n \"proident ipsum deserunt\",\n \"laborum est\"\n ],\n \"__moreField__\": \"nisi reprehenderit velit fugiat\"\n }\n}"},{"id":"a524dc93-56e5-4391-9ad7-badfb0cdc2b3","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/appointments/:appointmentId","host":["https://rest.gohighlevel.com"],"path":["v1","appointments",":appointmentId"],"variable":[{"key":"appointmentId","value":"004B1SpcAvh3s9E3rqk8","description":"(Required) Appointment Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"bdddff1b-c342-40fe-b878-4a9a51da5b36","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/appointments/:appointmentId","host":["https://rest.gohighlevel.com"],"path":["v1","appointments",":appointmentId"],"variable":[{"key":"appointmentId","value":"004B1SpcAvh3s9E3rqk8","description":"(Required) Appointment Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"52afdbbd-8558-4c2d-bc0f-fc1f88c82503"},{"name":"/v1/appointments/:appointmentId","id":"7c257ce6-c73a-4cb3-957b-ddbd99dfbd86","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"selectedTimezone\": \"Asia/Calcutta\",\n \"selectedSlot\": \"2020-08-28T15:30:00\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/appointments/:appointmentId","description":"

Update exisiting appoinment.


Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","appointments",":appointmentId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"12239db3-3b75-4128-b6ef-bd5148b8bf7a","description":{"content":"

(Required) Appointment Id

\n","type":"text/plain"},"type":"any","value":"004B1SpcAvh3s9E3rqk8","key":"appointmentId"}]}},"response":[{"id":"97025ef3-18aa-4c81-a217-accc15e6e3f2","name":"Successful response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"selectedTimezone\": \"Asia/Calcutta\",\n \"selectedSlot\": \"2020-08-28T15:30:00\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/appointments/:appointmentId","host":["https://rest.gohighlevel.com"],"path":["v1","appointments",":appointmentId"],"variable":[{"key":"appointmentId","value":"004B1SpcAvh3s9E3rqk8","description":"(Required) Appointment Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"004B1SpcAvh3s9E3rqk8\",\n \"contactId\": \"0007BWpSzSwfiuSl0tR2\",\n \"contact\": {\n \"id\": \"0007BWpSzSwfiuSl0tR2\",\n \"locationId\": \"C2QujeCh8ZnC7al2InWR\",\n \"email\": \"JohnDeo@gmail.com\",\n \"emailLowerCase\": \"johndeo@gmail.com\",\n \"fingerprint\": \"91f4f0e0-e2dd-11ea-9b16-53b2d72e8a24\",\n \"timezone\": \"Asia/Calcutta\",\n \"country\": \"DE\",\n \"customField\": [\n {\n \"id\": \"MgobCB14YMVKuE4Ka8p1\",\n \"value\": \"ea minim\"\n },\n {\n \"id\": \"MgobCB14YMVKuE4Ka8p1\",\n \"value\": \"qui culpa Ut\"\n }\n ],\n \"__moreField__\": \"ipsum\"\n }\n}"},{"id":"6fdec230-b43b-4dda-8883-287d301f7fac","name":"Bad Request. please contact support!","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"selectedTimezone\": \"Asia/Calcutta\",\n \"selectedSlot\": \"2020-08-28T15:30:00\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/appointments/:appointmentId","host":["https://rest.gohighlevel.com"],"path":["v1","appointments",":appointmentId"],"variable":[{"key":"appointmentId","value":"004B1SpcAvh3s9E3rqk8","description":"(Required) Appointment Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"4cbab6ea-5551-4982-a6d8-0b131e4da266","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"selectedTimezone\": \"Asia/Calcutta\",\n \"selectedSlot\": \"2020-08-28T15:30:00\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/appointments/:appointmentId","host":["https://rest.gohighlevel.com"],"path":["v1","appointments",":appointmentId"],"variable":[{"key":"appointmentId","value":"004B1SpcAvh3s9E3rqk8","description":"(Required) Appointment Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"b070d1ea-937e-402e-b7d6-e873c46b8b7f","name":"Unprocessable Entity","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"selectedTimezone\": \"Asia/Calcutta\",\n \"selectedSlot\": \"2020-08-28T15:30:00\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/appointments/:appointmentId","host":["https://rest.gohighlevel.com"],"path":["v1","appointments",":appointmentId"],"variable":[{"key":"appointmentId","value":"004B1SpcAvh3s9E3rqk8","description":"(Required) Appointment Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"selectedSlot\": {\n \"message\": \"The selected slot field is mandatory.\",\n \"rule\": \"required\"\n },\n \"selectedTimezone\": {\n \"message\": \"The selected timezone field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"7c257ce6-c73a-4cb3-957b-ddbd99dfbd86"},{"name":"/v1/appointments/:appointmentId","id":"d9bf928c-7edf-48cc-8a1a-e2d21ee946ef","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"DELETE","header":[],"url":"https://rest.gohighlevel.com/v1/appointments/:appointmentId","description":"

Delete exisiting appoinment.


Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","appointments",":appointmentId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"e0e313e7-e814-425c-b843-89e4085b3903","description":{"content":"

(Required) Appointment Id

\n","type":"text/plain"},"type":"any","value":"004B1SpcAvh3s9E3rqk8","key":"appointmentId"}]}},"response":[{"id":"3c8dde2e-4375-4e48-994c-fb3b423142e5","name":"Successful response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/appointments/:appointmentId","host":["https://rest.gohighlevel.com"],"path":["v1","appointments",":appointmentId"],"variable":[{"key":"appointmentId","value":"004B1SpcAvh3s9E3rqk8","description":"(Required) Appointment Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"\"\""},{"id":"5b65b5c6-ed6a-4343-b3f7-a42bb7315172","name":"Bad Request. please contact support!","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/appointments/:appointmentId","host":["https://rest.gohighlevel.com"],"path":["v1","appointments",":appointmentId"],"variable":[{"key":"appointmentId","value":"004B1SpcAvh3s9E3rqk8","description":"(Required) Appointment Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"33325be9-40e5-4fa4-b67b-b0ef9ec2849e","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/appointments/:appointmentId","host":["https://rest.gohighlevel.com"],"path":["v1","appointments",":appointmentId"],"variable":[{"key":"appointmentId","value":"004B1SpcAvh3s9E3rqk8","description":"(Required) Appointment Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"d9bf928c-7edf-48cc-8a1a-e2d21ee946ef"},{"name":"/v1/appointments/:appointmentId/status","id":"598a2ec9-a53a-4e56-ba66-77321fc59985","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": \"confirmed\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/appointments/:appointmentId/status","description":"

Update exisiting appoinment status.

Required JSON fields in the body

FieldsTypesExampleAllowed Options
statusstringconfirmed
  • confirmed
  • cancelled
  • showed
  • noshow
  • invalid

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","appointments",":appointmentId","status"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"26df79e3-c99b-4138-b69c-8fa40501595d","description":{"content":"

(Required) Appointment Id

\n","type":"text/plain"},"type":"any","value":"004B1SpcAvh3s9E3rqk8","key":"appointmentId"}]}},"response":[{"id":"cafa116b-3fde-4665-b03d-0a4341e82538","name":"Successful response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"status\": \"confirmed\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/appointments/:appointmentId/status","host":["https://rest.gohighlevel.com"],"path":["v1","appointments",":appointmentId","status"],"variable":[{"key":"appointmentId","value":"004B1SpcAvh3s9E3rqk8","description":"(Required) Appointment Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"0ac85843-1d9d-4a0a-b217-b1a16c3881ff","name":"Bad Request. please contact support!","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"status\": \"confirmed\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/appointments/:appointmentId/status","host":["https://rest.gohighlevel.com"],"path":["v1","appointments",":appointmentId","status"],"variable":[{"key":"appointmentId","value":"004B1SpcAvh3s9E3rqk8","description":"(Required) Appointment Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"c18fbe73-d508-4d10-9e19-6c874037961b","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"status\": \"confirmed\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/appointments/:appointmentId/status","host":["https://rest.gohighlevel.com"],"path":["v1","appointments",":appointmentId","status"],"variable":[{"key":"appointmentId","value":"004B1SpcAvh3s9E3rqk8","description":"(Required) Appointment Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"7c6fe910-10ae-4e0a-b1d6-810604496edf","name":"Unprocessable Entity","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"status\": \"confirmed\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/appointments/:appointmentId/status","host":["https://rest.gohighlevel.com"],"path":["v1","appointments",":appointmentId","status"],"variable":[{"key":"appointmentId","value":"004B1SpcAvh3s9E3rqk8","description":"(Required) Appointment Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": {\n \"message\": \"The status field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"598a2ec9-a53a-4e56-ba66-77321fc59985"}],"id":"48657c5a-b207-4a14-88d5-5bbc365ff591","description":"

Booking Appointment

\n","_postman_id":"48657c5a-b207-4a14-88d5-5bbc365ff591","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","name":"GoHighLevel API V1.1.20","type":"collection"}}}],"id":"f4afdf37-b780-48e4-8e97-9e32eefc9227","description":"

Using our robust API you can customize and manage the appointment scheduling workflow that works for your products and services while we do all the leg work behind the scenes.

\n","_postman_id":"f4afdf37-b780-48e4-8e97-9e32eefc9227","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","name":"GoHighLevel API V1.1.20","type":"collection"}}},{"name":"Campaign","item":[{"name":"/v1/campaigns/","id":"cd973412-f822-41d9-a1d3-06503eac7440","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/campaigns/?status=published","description":"

Get Campaigns.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","campaigns",""],"host":["https://rest.gohighlevel.com"],"query":[{"description":{"content":"

Filter by status, Allowed option are draft or published.

\n","type":"text/plain"},"key":"status","value":"published"}],"variable":[]}},"response":[{"id":"4520c162-1126-4382-9f5b-08484ab4401f","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/campaigns/?status=published","host":["https://rest.gohighlevel.com"],"path":["v1","campaigns",""],"query":[{"key":"status","value":"published"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"campaigns\": [\n {\n \"id\": \"Y2I9XM7aO1hncuSOlc9L\",\n \"name\": \"Test Campaign\",\n \"status\": \"draft\"\n },\n {\n \"id\": \"Y2I9XM7aO1hncuSOlc9L\",\n \"name\": \"Test Campaign\",\n \"status\": \"draft\"\n }\n ]\n}"},{"id":"57ba8be7-3951-4100-90db-00062a79445c","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/campaigns/?status=published","host":["https://rest.gohighlevel.com"],"path":["v1","campaigns",""],"query":[{"key":"status","value":"published"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"11d1cab9-1e41-4891-9ec9-a4a2fb38141c","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/campaigns/?status=published","host":["https://rest.gohighlevel.com"],"path":["v1","campaigns",""],"query":[{"key":"status","value":"published"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"cd973412-f822-41d9-a1d3-06503eac7440"}],"id":"7e4e46fc-a09b-433c-8f1b-f517886a5959","_postman_id":"7e4e46fc-a09b-433c-8f1b-f517886a5959","description":"","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","name":"GoHighLevel API V1.1.20","type":"collection"}}},{"name":"Contact","item":[{"name":"Contact Appointment","item":[{"name":"/v1/contacts/:contactId/appointments/","id":"af42b0d8-f002-4d09-a1a9-f860d653127f","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/contacts/:contactId/appointments/","description":"

Get contact appointments.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","contacts",":contactId","appointments",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"a8297378-d3fe-4d0a-bbba-a1198001c9c9","description":{"content":"

(Required) Contact Id

\n","type":"text/plain"},"type":"any","value":"sx6wyHhbFdRXh302LLNR","key":"contactId"}]}},"response":[{"id":"96855e24-1d72-4a13-9600-4af5bc48afb7","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/appointments/","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","appointments",""],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"e853ff56-5181-43af-9e64-12742c527116","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/appointments/","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","appointments",""],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"551eb6df-40fc-472c-a532-1a12a39af67e","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/appointments/","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","appointments",""],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"af42b0d8-f002-4d09-a1a9-f860d653127f"}],"id":"dbf523a3-c344-44cc-adf7-34b68c40dc81","_postman_id":"dbf523a3-c344-44cc-adf7-34b68c40dc81","description":"","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","name":"GoHighLevel API V1.1.20","type":"collection"}}},{"name":"Contact Tag","item":[{"name":"/v1/contacts/:contactId/tags/","id":"2b4583f4-d525-43a3-89dc-0034e864df02","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"tags\": [\n \"dolore cillum\",\n \"ex proident cillum sed sint\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/contacts/:contactId/tags/","description":"

Add Tags on contacts.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","contacts",":contactId","tags",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"95fed7ef-86ee-43b6-9b28-25a5f62b83b8","description":{"content":"

(Required) Contact Id

\n","type":"text/plain"},"type":"any","value":"sx6wyHhbFdRXh302LLNR","key":"contactId"}]}},"response":[{"id":"4c01883e-1e97-4ce0-9a76-f7caace1c49b","name":"Successful response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"tags\": [\n \"n\",\n \"in dolore esse dol\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tags/","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tags",""],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"tags\": [\n \"velit exer\",\n \"sed ad\"\n ]\n}"},{"id":"4a92fe00-576a-4e4c-89af-cefc040b4f4e","name":"Bad Request. please contact support!","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"tags\": [\n \"n\",\n \"in dolore esse dol\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tags/","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tags",""],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"d0e94bed-f068-4aab-a4fa-f84ff98e9835","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"tags\": [\n \"n\",\n \"in dolore esse dol\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tags/","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tags",""],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"c1e4e8aa-bab8-4444-9d8b-e90b52f64709","name":"Unprocessable Entity","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"tags\": [\n \"n\",\n \"in dolore esse dol\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tags/","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tags",""],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"tags\": {\n \"message\": \"The tags field is mandatory.\",\n \"rules\": \"required\"\n }\n}"}],"_postman_id":"2b4583f4-d525-43a3-89dc-0034e864df02"},{"name":"/v1/contacts/:contactId/tags/","id":"14572da1-a341-42dc-a42c-ac0742d6178e","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"tags\": [\n \"n\",\n \"in dolore esse dol\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/contacts/:contactId/tags/","description":"

Delete tags from the contact.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","contacts",":contactId","tags",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"b4236250-2915-4cb5-b893-d54885838b55","description":{"content":"

(Required) Contact Id

\n","type":"text/plain"},"type":"any","value":"sx6wyHhbFdRXh302LLNR","key":"contactId"}]}},"response":[{"id":"5de1ca0d-49c5-4c3a-9649-cab729c47248","name":"Successful response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"tags\": [\n \"n\",\n \"in dolore esse dol\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tags/","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tags",""],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"tags\": [\n \"consequat\",\n \"culpa ut\"\n ]\n}"},{"id":"19932c71-7af9-433f-b23a-8146c0d070aa","name":"Bad Request. please contact support!","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"tags\": [\n \"n\",\n \"in dolore esse dol\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tags/","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tags",""],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"3ff5419e-9c23-4e7a-922d-7332cbdcf942","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"tags\": [\n \"n\",\n \"in dolore esse dol\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tags/","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tags",""],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"87f21456-c0db-4a4f-91ce-d00551133599","name":"Unprocessable Entity","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"tags\": [\n \"n\",\n \"in dolore esse dol\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tags/","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tags",""],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"tags\": {\n \"message\": \"The tags field is mandatory.\",\n \"rules\": \"required\"\n }\n}"}],"_postman_id":"14572da1-a341-42dc-a42c-ac0742d6178e"}],"id":"dbb4ae8d-1fcc-45ce-a3f8-34fafe771e90","_postman_id":"dbb4ae8d-1fcc-45ce-a3f8-34fafe771e90","description":"","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","name":"GoHighLevel API V1.1.20","type":"collection"}}},{"name":"Contact Campaign","item":[{"name":"/v1/contacts/:contactId/campaigns/:campaignId","id":"fa41c0d0-581f-4682-ae67-cd67ecf9fda5","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[],"url":"https://rest.gohighlevel.com/v1/contacts/:contactId/campaigns/:campaignId","description":"

Add contact to campaign.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","contacts",":contactId","campaigns",":campaignId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"f67a8098-40d4-4cd6-a739-b99cf3381f12","description":{"content":"

(Required) Contact Id

\n","type":"text/plain"},"type":"any","value":"sx6wyHhbFdRXh302LLNR","key":"contactId"},{"id":"aba70336-7a95-46e7-8472-94eb25a61e4b","description":{"content":"

(Required) Campaign Id

\n","type":"text/plain"},"type":"any","value":"Y2I9XM7aO1hncuSOlc9L","key":"campaignId"}]}},"response":[{"id":"92494a09-ff33-43c2-965c-30d056ca00ff","name":"Successful response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/campaigns/:campaignId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","campaigns",":campaignId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"campaignId","value":"Y2I9XM7aO1hncuSOlc9L","description":"(Required) Campaign Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"\"\""},{"id":"4530c237-9863-4c1d-88ae-3e70d158dfce","name":"Bad Request. please contact support!","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/campaigns/:campaignId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","campaigns",":campaignId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"campaignId","value":"Y2I9XM7aO1hncuSOlc9L","description":"(Required) Campaign Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"46605bfd-67ad-4fa3-a670-5d77c143f75f","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/campaigns/:campaignId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","campaigns",":campaignId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"campaignId","value":"Y2I9XM7aO1hncuSOlc9L","description":"(Required) Campaign Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"e6295cac-ce37-474d-8dc7-d27c8b437761","name":"Unprocessable Entity","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/campaigns/:campaignId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","campaigns",":campaignId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"campaignId","value":"Y2I9XM7aO1hncuSOlc9L","description":"(Required) Campaign Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"tags\": {\n \"message\": \"The tags field is mandatory.\",\n \"rules\": \"required\"\n }\n}"}],"_postman_id":"fa41c0d0-581f-4682-ae67-cd67ecf9fda5"},{"name":"/v1/contacts/:contactId/campaigns/:campaignId","id":"fbc58eeb-960e-424a-bb7e-4c69a22f6557","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"DELETE","header":[],"url":"https://rest.gohighlevel.com/v1/contacts/:contactId/campaigns/:campaignId","description":"

Remove contact from campaign.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","contacts",":contactId","campaigns",":campaignId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"99225783-aa9c-4292-a0be-d1b1a8e81bdb","description":{"content":"

(Required) Contact Id

\n","type":"text/plain"},"type":"any","value":"sx6wyHhbFdRXh302LLNR","key":"contactId"},{"id":"8cce362a-9f87-4bab-a583-808f5a3b6018","description":{"content":"

(Required) Campaign Id

\n","type":"text/plain"},"type":"any","value":"Y2I9XM7aO1hncuSOlc9L","key":"campaignId"}]}},"response":[{"id":"fd871b94-be75-4304-b591-bfb289563dec","name":"Successful response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/campaigns/:campaignId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","campaigns",":campaignId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"campaignId","value":"Y2I9XM7aO1hncuSOlc9L","description":"(Required) Campaign Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"\"\""},{"id":"fdc90de0-ef19-4695-b98f-a99ee7772d85","name":"Bad Request. please contact support!","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/campaigns/:campaignId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","campaigns",":campaignId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"campaignId","value":"Y2I9XM7aO1hncuSOlc9L","description":"(Required) Campaign Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"dab57d77-d7fa-4ed7-b4ef-f24df95fd232","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/campaigns/:campaignId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","campaigns",":campaignId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"campaignId","value":"Y2I9XM7aO1hncuSOlc9L","description":"(Required) Campaign Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"313a5187-daea-424c-9404-db9e9eeaa543","name":"Unprocessable Entity","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/campaigns/:campaignId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","campaigns",":campaignId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"campaignId","value":"Y2I9XM7aO1hncuSOlc9L","description":"(Required) Campaign Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"tags\": {\n \"message\": \"The tags field is mandatory.\",\n \"rules\": \"required\"\n }\n}"}],"_postman_id":"fbc58eeb-960e-424a-bb7e-4c69a22f6557"},{"name":"/v1/contacts/:contactId/campaigns/remove-all","id":"a12cdf8e-369c-41b0-b41e-f412ca0c94e3","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"DELETE","header":[],"url":"https://rest.gohighlevel.com/v1/contacts/:contactId/campaigns/remove-all","description":"

Remove contact from every campaign.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","contacts",":contactId","campaigns","remove-all"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"4aa48144-85e9-42c6-8181-488a966db7fa","description":{"content":"

(Required) Contact Id

\n","type":"text/plain"},"type":"any","value":"sx6wyHhbFdRXh302LLNR","key":"contactId"}]}},"response":[{"id":"aaa9fc31-4ea5-4f9c-a6f1-71fa32337b4a","name":"Successful response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/campaigns/remove-all","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","campaigns","remove-all"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"\"\""},{"id":"408905cd-e0c5-4abb-b5ca-96343057c9aa","name":"Bad Request. please contact support!","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/campaigns/remove-all","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","campaigns","remove-all"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"59ec0e25-700e-4d0f-b15a-3b4b5e68969e","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/campaigns/remove-all","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","campaigns","remove-all"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"89ea6511-0012-4ed5-bcfa-a5151b4f2690","name":"Unprocessable Entity","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/campaigns/remove-all","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","campaigns","remove-all"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"tags\": {\n \"message\": \"The tags field is mandatory.\",\n \"rules\": \"required\"\n }\n}"}],"_postman_id":"a12cdf8e-369c-41b0-b41e-f412ca0c94e3"}],"id":"8a506dff-cea3-48bc-909f-4f85a0e8a7be","_postman_id":"8a506dff-cea3-48bc-909f-4f85a0e8a7be","description":"","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","name":"GoHighLevel API V1.1.20","type":"collection"}}},{"name":"Contact Workflow","item":[{"name":"/v1/contacts/:contactId/workflow/:workflowId","id":"e0032d0a-a392-4d32-b96f-ae09124444fe","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"eventStartTime\": \"2021-05-26T11:33:49.000Z\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/contacts/:contactId/workflow/:workflowId","description":"

Add contact to the workflow.

Adding contact into workflow will allow these fields.

FieldsTypesExample
eventStartTimestring(datetime with timezone offset).2021-06-23T03:30:00+01:00

Note:

This request will add contact in queue to be added in workflow. This will not get to be added realtime.


Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","contacts",":contactId","workflow",":workflowId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"1fd76a21-8b3b-489d-8d4a-cd48544ccf1b","description":{"content":"

(Required) Contact Id

\n","type":"text/plain"},"type":"any","value":"sx6wyHhbFdRXh302LLNR","key":"contactId"},{"id":"e4d7eead-10d9-4bc0-be36-69f1848ca08b","description":{"content":"

(Required) Workflow Id

\n","type":"text/plain"},"type":"any","value":"78559bb3-b920-461e-b010-7b2a2816d2a9","key":"workflowId"}]}},"response":[{"id":"82a98fbb-dedc-46ac-9225-2d81eba77870","name":"Successful response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"eventStartTime\": \"2021-05-26T11:33:49.000Z\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/workflow/:workflowId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","workflow",":workflowId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"workflowId","value":"78559bb3-b920-461e-b010-7b2a2816d2a9","description":"(Required) Workflow Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"\"\""},{"id":"febcf4e6-a3d8-4da7-809a-5c5fafb0012b","name":"Bad Request. please contact support!","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"eventStartTime\": \"2021-05-26T11:33:49.000Z\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/workflow/:workflowId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","workflow",":workflowId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"workflowId","value":"78559bb3-b920-461e-b010-7b2a2816d2a9","description":"(Required) Workflow Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"5e4bf416-f825-48b6-b606-f9cb76f3a686","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"eventStartTime\": \"2021-05-26T11:33:49.000Z\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/workflow/:workflowId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","workflow",":workflowId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"workflowId","value":"78559bb3-b920-461e-b010-7b2a2816d2a9","description":"(Required) Workflow Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"d1e863af-ca2e-4b6e-9217-1d0cb584c604","name":"Unprocessable Entity","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"eventStartTime\": \"2021-05-26T11:33:49.000Z\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/workflow/:workflowId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","workflow",":workflowId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"workflowId","value":"78559bb3-b920-461e-b010-7b2a2816d2a9","description":"(Required) Workflow Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"contactId\": \"The contact id is invalid.\",\n \"workflowId\": \"The workflow id is invalid.\"\n}"}],"_postman_id":"e0032d0a-a392-4d32-b96f-ae09124444fe"}],"id":"69e65f13-93c5-4ae0-96ae-bb0e668d636c","_postman_id":"69e65f13-93c5-4ae0-96ae-bb0e668d636c","description":"","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","name":"GoHighLevel API V1.1.20","type":"collection"}}},{"name":"/v1/contacts/","id":"dac71866-cddd-48e9-ba77-99fd293594fa","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/contacts/?startAfterId=UIaE1WjAwWKdlyD7osQI&startAfter=1603870249758&limit=20&query=John","description":"

Get Contacts.

Filters:
FieldsDescription
queryIt will search on these fields: Name, Phone, Email, Tags, and Company Name.
Sorting:
FieldsAllowed OptionsDefault value
sortBydate_added or date_updateddate_added
orderasc or descdesc
Pagination:

We will by default return the first matched 20 contacts. You can fetched next and more by passing the page on the query params (deprecated). You can see page info and total records count on to the meta

New: You can fetched next and more by passing the startAfter and startAfterId on the query params. You can see startAfterId and startAfter fields found into the response meta field.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","contacts",""],"host":["https://rest.gohighlevel.com"],"query":[{"description":{"content":"

Start After Id

\n","type":"text/plain"},"key":"startAfterId","value":"UIaE1WjAwWKdlyD7osQI"},{"description":{"content":"

Start After

\n","type":"text/plain"},"key":"startAfter","value":"1603870249758"},{"description":{"content":"

Limit Per Page records count. will allow maximum up to 100 and default will be 20

\n","type":"text/plain"},"key":"limit","value":"20"},{"description":{"content":"

Contact Query

\n","type":"text/plain"},"key":"query","value":"John"}],"variable":[]}},"response":[{"id":"574133d7-01fc-44bd-8ff4-268b1bc867f7","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/?startAfterId=UIaE1WjAwWKdlyD7osQI&startAfter=1603870249758&limit=20&query=John","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",""],"query":[{"key":"startAfterId","value":"UIaE1WjAwWKdlyD7osQI"},{"key":"startAfter","value":"1603870249758"},{"key":"limit","value":"20"},{"key":"query","value":"John"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"contacts\": [\n {\n \"id\": \"ocQHyuzHvysMo5N5VsXc\",\n \"locationId\": \"C2QujeCh8ZnC7al2InWR\",\n \"email\": \"JohnDeo@gmail.com\",\n \"emailLowerCase\": \"johndeo@gmail.com\",\n \"fingerprint\": \"91f4f0e0-e2dd-11ea-9b16-53b2d72e8a24\",\n \"timezone\": \"Asia/Calcutta\",\n \"country\": \"DE\",\n \"source\": \"xyz form\",\n \"dateAdded\": \"2020-10-29T09:31:30.255Z\",\n \"customField\": [\n {\n \"id\": \"MgobCB14YMVKuE4Ka8p1\",\n \"value\": \"cillum in ullamco dolor commodo\"\n },\n {\n \"id\": \"MgobCB14YMVKuE4Ka8p1\",\n \"value\": \"tempor\"\n }\n ],\n \"tags\": [\n \"magna ut sint labore lab\",\n \"Duis nulla cillum\"\n ],\n \"__moreField__\": \"ut consequat sit\"\n },\n {\n \"id\": \"ocQHyuzHvysMo5N5VsXc\",\n \"locationId\": \"C2QujeCh8ZnC7al2InWR\",\n \"email\": \"JohnDeo@gmail.com\",\n \"emailLowerCase\": \"johndeo@gmail.com\",\n \"fingerprint\": \"91f4f0e0-e2dd-11ea-9b16-53b2d72e8a24\",\n \"timezone\": \"Asia/Calcutta\",\n \"country\": \"DE\",\n \"source\": \"xyz form\",\n \"dateAdded\": \"2020-10-29T09:31:30.255Z\",\n \"customField\": [\n {\n \"id\": \"MgobCB14YMVKuE4Ka8p1\",\n \"value\": \"Duis Excepteur cupidatat d\"\n },\n {\n \"id\": \"MgobCB14YMVKuE4Ka8p1\",\n \"value\": \"pariatur\"\n }\n ],\n \"tags\": [\n \"veniam amet velit commodo\",\n \"ullamco eu sit mollit\"\n ],\n \"__moreField__\": \"cupidatat sit anim\"\n }\n ],\n \"meta\": {\n \"total\": 250,\n \"nextPageUrl\": \"https://rest.gohighlevel.com/v1/contacts?limit=1&q=j&startAfter=1603870249758&startAfterId=UIaE1WjAwWKdlyD7osQI\",\n \"startAfterId\": \"UIaE1WjAwWKdlyD7osQI\",\n \"startAfter\": 1603870249758,\n \"currentPage\": 2,\n \"nextPage\": 3,\n \"prevPage\": 1\n }\n}"},{"id":"4aa1fa6b-23a2-42a4-9088-037f2bded82b","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/?startAfterId=UIaE1WjAwWKdlyD7osQI&startAfter=1603870249758&limit=20&query=John","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",""],"query":[{"key":"startAfterId","value":"UIaE1WjAwWKdlyD7osQI"},{"key":"startAfter","value":"1603870249758"},{"key":"limit","value":"20"},{"key":"query","value":"John"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"e7ce63c7-551b-4a61-8c12-ccfff0c6030c","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/?startAfterId=UIaE1WjAwWKdlyD7osQI&startAfter=1603870249758&limit=20&query=John","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",""],"query":[{"key":"startAfterId","value":"UIaE1WjAwWKdlyD7osQI"},{"key":"startAfter","value":"1603870249758"},{"key":"limit","value":"20"},{"key":"query","value":"John"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"dac71866-cddd-48e9-ba77-99fd293594fa"},{"name":"/v1/contacts/","id":"5fbc2b83-603d-4974-81c3-7d8658a79594","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"email\": \"john@deo.com\",\n \"phone\": \"+18887324197\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"name\": \"John Deo\",\n \"dateOfBirth\": \"1990-09-25\",\n \"address1\": \"3535 1st St N\",\n \"city\": \"Dolomite\",\n \"state\": \"AL\",\n \"country\": \"US\",\n \"postalCode\": \"35061\",\n \"companyName\": \"DGS VolMAX\",\n \"website\": \"35061\",\n \"tags\": [\n \"aute consequat ad ea\",\n \"dolor sed\"\n ],\n \"source\": \"public api\",\n \"customField\": {\n \"__custom_field_id__\": \"exercitation\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/contacts/","description":"

Create a contact.

Create contact will allow this fields. ex:

FieldsTypesExample
firstNamestringJohn
lastNamestringDeo
namestringJohn Deo
emailstringjohndeo@gmail.com
phonestring+1 888-888-8888
address1longTonkawa Trail W
citystringAustin
statestringTexas
postalCodestring45001
websitestring(url)https://www.google.com
timezonestringAmerica/Chihuahua
dndbooleantrue
tagsarray[\"tag1\", \"tag2\"]
customFieldobject{\"3r6dEOnsApNaKIhnFM6u\": \"Value 1\", \"MgobCB14YMVKuE4Ka8p1\": \"Value 2\"}. Notes: 3r6dEOnsApNaKIhnFM6u and MgobCB14YMVKuE4Ka8p1 is a custom field id. You can find it using *Custom Fields* endpoints.
sourcestringPublic API

Validation:

Email or Phone are required to create contact

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","contacts",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[]}},"response":[{"id":"5f621f3e-bda1-4a5a-b10c-fe59f8e65407","name":"Successful response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"email\": \"john@deo.com\",\n \"phone\": \"+18887324197\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"name\": \"John Deo\",\n \"dateOfBirth\": \"1990-09-25\",\n \"address1\": \"3535 1st St N\",\n \"city\": \"Dolomite\",\n \"state\": \"AL\",\n \"country\": \"US\",\n \"postalCode\": \"35061\",\n \"companyName\": \"DGS VolMAX\",\n \"website\": \"35061\",\n \"tags\": [\n \"commodo\",\n \"veniam ut reprehenderit\"\n ],\n \"source\": \"public api\",\n \"customField\": {\n \"__custom_field_id__\": \"do in Lorem ut exercitation\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/contacts/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"contact\": {\n \"id\": \"ocQHyuzHvysMo5N5VsXc\",\n \"locationId\": \"C2QujeCh8ZnC7al2InWR\",\n \"email\": \"JohnDeo@gmail.com\",\n \"emailLowerCase\": \"johndeo@gmail.com\",\n \"fingerprint\": \"91f4f0e0-e2dd-11ea-9b16-53b2d72e8a24\",\n \"timezone\": \"Asia/Calcutta\",\n \"country\": \"DE\",\n \"source\": \"xyz form\",\n \"dateAdded\": \"2020-10-29T09:31:30.255Z\",\n \"customField\": [\n {\n \"id\": \"MgobCB14YMVKuE4Ka8p1\",\n \"value\": \"ea laboris consectetur elit sit\"\n },\n {\n \"id\": \"MgobCB14YMVKuE4Ka8p1\",\n \"value\": \"incididunt cupidatat nostrud qu\"\n }\n ],\n \"tags\": [\n \"laboris esse ut irure\",\n \"eiusmod exercitation irure ut\"\n ],\n \"__moreField__\": \"consequat\"\n }\n}"},{"id":"85037d76-ad4a-445c-a4e9-fc5cb03cdedb","name":"Bad Request. please contact support!","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"email\": \"john@deo.com\",\n \"phone\": \"+18887324197\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"name\": \"John Deo\",\n \"dateOfBirth\": \"1990-09-25\",\n \"address1\": \"3535 1st St N\",\n \"city\": \"Dolomite\",\n \"state\": \"AL\",\n \"country\": \"US\",\n \"postalCode\": \"35061\",\n \"companyName\": \"DGS VolMAX\",\n \"website\": \"35061\",\n \"tags\": [\n \"commodo\",\n \"veniam ut reprehenderit\"\n ],\n \"source\": \"public api\",\n \"customField\": {\n \"__custom_field_id__\": \"do in Lorem ut exercitation\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/contacts/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"165bd403-5ffe-4930-8f39-eeb9cc4fccb5","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"email\": \"john@deo.com\",\n \"phone\": \"+18887324197\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"name\": \"John Deo\",\n \"dateOfBirth\": \"1990-09-25\",\n \"address1\": \"3535 1st St N\",\n \"city\": \"Dolomite\",\n \"state\": \"AL\",\n \"country\": \"US\",\n \"postalCode\": \"35061\",\n \"companyName\": \"DGS VolMAX\",\n \"website\": \"35061\",\n \"tags\": [\n \"commodo\",\n \"veniam ut reprehenderit\"\n ],\n \"source\": \"public api\",\n \"customField\": {\n \"__custom_field_id__\": \"do in Lorem ut exercitation\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/contacts/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"561fb661-2e6b-47e1-9599-6f7b707ed1f7","name":"Unprocessable Entity","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"email\": \"john@deo.com\",\n \"phone\": \"+18887324197\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"name\": \"John Deo\",\n \"dateOfBirth\": \"1990-09-25\",\n \"address1\": \"3535 1st St N\",\n \"city\": \"Dolomite\",\n \"state\": \"AL\",\n \"country\": \"US\",\n \"postalCode\": \"35061\",\n \"companyName\": \"DGS VolMAX\",\n \"website\": \"35061\",\n \"tags\": [\n \"commodo\",\n \"veniam ut reprehenderit\"\n ],\n \"source\": \"public api\",\n \"customField\": {\n \"__custom_field_id__\": \"do in Lorem ut exercitation\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/contacts/"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"email or phone\": {\n \"message\": \"The email or phone field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"5fbc2b83-603d-4974-81c3-7d8658a79594"},{"name":"/v1/contacts/lookup","id":"5f4bde90-5179-43b2-b38d-f09b7bb771ad","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/contacts/lookup?email=john@deo.com&phone=+491971259866","description":"

Search contact by email or phone number.

If you will pass email or phone, it will try find and give contacts based on that.

OR If you will pass both first it will try to find contact with email first and if it is not able to find contact then it will try to find the match based on the phone.

Authorization:

Provide your location api key (Bearer Token). You can find here

Validation:

Email or Phone are required to lookup contact.

","urlObject":{"path":["v1","contacts","lookup"],"host":["https://rest.gohighlevel.com"],"query":[{"description":{"content":"

(Required) Contact email

\n","type":"text/plain"},"key":"email","value":"john@deo.com"},{"description":{"content":"

(Required) Contact phone

\n","type":"text/plain"},"key":"phone","value":"+491971259866"}],"variable":[]}},"response":[{"id":"d4ae351d-6c4d-4d34-8df0-a2431cd3faa9","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/lookup?email=john@deo.com&phone=+491971259866","host":["https://rest.gohighlevel.com"],"path":["v1","contacts","lookup"],"query":[{"key":"email","value":"john@deo.com"},{"key":"phone","value":"+491971259866"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"contacts\": [\n {\n \"id\": \"ocQHyuzHvysMo5N5VsXc\",\n \"locationId\": \"C2QujeCh8ZnC7al2InWR\",\n \"email\": \"JohnDeo@gmail.com\",\n \"emailLowerCase\": \"johndeo@gmail.com\",\n \"fingerprint\": \"91f4f0e0-e2dd-11ea-9b16-53b2d72e8a24\",\n \"timezone\": \"Asia/Calcutta\",\n \"country\": \"DE\",\n \"source\": \"xyz form\",\n \"dateAdded\": \"2020-10-29T09:31:30.255Z\",\n \"customField\": [\n {\n \"id\": \"MgobCB14YMVKuE4Ka8p1\",\n \"value\": \"quis Excepteur nisi officia\"\n },\n {\n \"id\": \"MgobCB14YMVKuE4Ka8p1\",\n \"value\": \"laborum\"\n }\n ],\n \"tags\": [\n \"et incidi\",\n \"nulla eu commodo aliqua\"\n ],\n \"__moreField__\": \"exercitation nostrud ea\"\n },\n {\n \"id\": \"ocQHyuzHvysMo5N5VsXc\",\n \"locationId\": \"C2QujeCh8ZnC7al2InWR\",\n \"email\": \"JohnDeo@gmail.com\",\n \"emailLowerCase\": \"johndeo@gmail.com\",\n \"fingerprint\": \"91f4f0e0-e2dd-11ea-9b16-53b2d72e8a24\",\n \"timezone\": \"Asia/Calcutta\",\n \"country\": \"DE\",\n \"source\": \"xyz form\",\n \"dateAdded\": \"2020-10-29T09:31:30.255Z\",\n \"customField\": [\n {\n \"id\": \"MgobCB14YMVKuE4Ka8p1\",\n \"value\": \"consequat tempor sed cillum\"\n },\n {\n \"id\": \"MgobCB14YMVKuE4Ka8p1\",\n \"value\": \"occaecat anim\"\n }\n ],\n \"tags\": [\n \"deserunt sed est\",\n \"consequat id irure\"\n ],\n \"__moreField__\": \"qui dolor Lorem\"\n }\n ]\n}"},{"id":"89c8f760-b8a0-4740-8d0c-207d20a1588c","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/lookup?email=john@deo.com&phone=+491971259866","host":["https://rest.gohighlevel.com"],"path":["v1","contacts","lookup"],"query":[{"key":"email","value":"john@deo.com"},{"key":"phone","value":"+491971259866"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"e7f1cd6e-2a2a-4d29-9c6c-85c83363f7fc","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/lookup?email=john@deo.com&phone=+491971259866","host":["https://rest.gohighlevel.com"],"path":["v1","contacts","lookup"],"query":[{"key":"email","value":"john@deo.com"},{"key":"phone","value":"+491971259866"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"5d799f5a-0c7e-41ec-a716-8a96ce09e526","name":"Unprocessable Entity","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/lookup?email=john@deo.com&phone=+491971259866","host":["https://rest.gohighlevel.com"],"path":["v1","contacts","lookup"],"query":[{"key":"email","value":"john@deo.com"},{"key":"phone","value":"+491971259866"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"email or phone\": {\n \"message\": \"The email or phone field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"5f4bde90-5179-43b2-b38d-f09b7bb771ad"},{"name":"/v1/contacts/:id","id":"4b27c336-c46c-471a-863f-7a4185f31a90","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/contacts/:id","description":"

Get contact by id.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","contacts",":id"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"f3e4d00b-d7ff-4e34-b9f5-868c22e52833","description":{"content":"

(Required) Contact Id

\n","type":"text/plain"},"type":"any","value":"ocQHyuzHvysMo5N5VsXc","key":"id"}]}},"response":[{"id":"01a6b506-6257-4879-acec-0d65ea1f9790","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:id","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":id"],"variable":[{"key":"id","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Contact Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"contact\": {\n \"id\": \"ocQHyuzHvysMo5N5VsXc\",\n \"locationId\": \"C2QujeCh8ZnC7al2InWR\",\n \"email\": \"JohnDeo@gmail.com\",\n \"emailLowerCase\": \"johndeo@gmail.com\",\n \"fingerprint\": \"91f4f0e0-e2dd-11ea-9b16-53b2d72e8a24\",\n \"timezone\": \"Asia/Calcutta\",\n \"country\": \"DE\",\n \"source\": \"xyz form\",\n \"dateAdded\": \"2020-10-29T09:31:30.255Z\",\n \"customField\": [\n {\n \"id\": \"MgobCB14YMVKuE4Ka8p1\",\n \"value\": \"ea laboris consectetur elit sit\"\n },\n {\n \"id\": \"MgobCB14YMVKuE4Ka8p1\",\n \"value\": \"incididunt cupidatat nostrud qu\"\n }\n ],\n \"tags\": [\n \"laboris esse ut irure\",\n \"eiusmod exercitation irure ut\"\n ],\n \"__moreField__\": \"consequat\"\n }\n}"},{"id":"5122e692-4f8d-45f6-94ef-ac50d20d7a81","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:id","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":id"],"variable":[{"key":"id","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Contact Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"e9dec0a9-a4e2-4e6d-93f5-47f5f25610b1","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:id","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":id"],"variable":[{"key":"id","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Contact Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"460f8718-d979-4870-a8f9-6191860c54fc","name":"Unprocessable Entity","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:id","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":id"],"variable":[{"key":"id","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Contact Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": {\n \"message\": \"The contact id is invalid.\",\n \"rule\": \"invalid\"\n }\n}"}],"_postman_id":"4b27c336-c46c-471a-863f-7a4185f31a90"},{"name":"/v1/contacts/:id","id":"1c7060e2-ebaf-4b5b-9248-be0292689bba","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"name\": \"John Deo\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+18887324197\",\n \"dateOfBirth\": \"1990-09-25\",\n \"address1\": \"3535 1st St N\",\n \"city\": \"Dolomite\",\n \"state\": \"AL\",\n \"country\": \"US\",\n \"postalCode\": \"35061\",\n \"companyName\": \"DGS VolMAX\",\n \"website\": \"35061\",\n \"tags\": [\n \"ea deserunt culpa laboris\",\n \"quis in veniam qui\"\n ],\n \"source\": \"public api\",\n \"customField\": {\n \"__custom_field_id__\": \"ea d\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/contacts/:id","description":"

Update a contact.

Update contact will allow this fields. ex:

FieldsTypesExample
firstNamestringJohn
lastNamestringDeo
namestringJohn Deo
emailstringjohndeo@gmail.com
phonestring+1 888-888-8888
address1longTonkawa Trail W
citystringAustin
statestringTexas
postalCodestring45001
websitestring(url)https://www.google.com
timezonestringAmerica/Chihuahua
dndbooleantrue
tagsarray[\"tag1\", \"tag2\"]
customFieldobject{\"3r6dEOnsApNaKIhnFM6u\": \"Value 1\", \"MgobCB14YMVKuE4Ka8p1\": \"Value 2\"}. Notes: 3r6dEOnsApNaKIhnFM6u and MgobCB14YMVKuE4Ka8p1 is a custom field id. You can find it using *Custom Fields* endpoints.
sourcestringPublic API

Validation:

Email or Phone are required to update contact

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","contacts",":id"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"b1247df2-6f0e-44e5-be73-198b010790b5","description":{"content":"

(Required) Contact Id

\n","type":"text/plain"},"type":"any","value":"ocQHyuzHvysMo5N5VsXc","key":"id"}]}},"response":[{"id":"08bb1197-ac50-4215-9710-395127eebd1e","name":"Successful response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"name\": \"John Deo\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+18887324197\",\n \"dateOfBirth\": \"1990-09-25\",\n \"address1\": \"3535 1st St N\",\n \"city\": \"Dolomite\",\n \"state\": \"AL\",\n \"country\": \"US\",\n \"postalCode\": \"35061\",\n \"companyName\": \"DGS VolMAX\",\n \"website\": \"35061\",\n \"tags\": [\n \"ea deserunt culpa laboris\",\n \"quis in veniam qui\"\n ],\n \"source\": \"public api\",\n \"customField\": {\n \"__custom_field_id__\": \"ea d\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:id","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":id"],"variable":[{"key":"id","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Contact Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"contact\": {\n \"id\": \"ocQHyuzHvysMo5N5VsXc\",\n \"locationId\": \"C2QujeCh8ZnC7al2InWR\",\n \"email\": \"JohnDeo@gmail.com\",\n \"emailLowerCase\": \"johndeo@gmail.com\",\n \"fingerprint\": \"91f4f0e0-e2dd-11ea-9b16-53b2d72e8a24\",\n \"timezone\": \"Asia/Calcutta\",\n \"country\": \"DE\",\n \"source\": \"xyz form\",\n \"dateAdded\": \"2020-10-29T09:31:30.255Z\",\n \"customField\": [\n {\n \"id\": \"MgobCB14YMVKuE4Ka8p1\",\n \"value\": \"ea laboris consectetur elit sit\"\n },\n {\n \"id\": \"MgobCB14YMVKuE4Ka8p1\",\n \"value\": \"incididunt cupidatat nostrud qu\"\n }\n ],\n \"tags\": [\n \"laboris esse ut irure\",\n \"eiusmod exercitation irure ut\"\n ],\n \"__moreField__\": \"consequat\"\n }\n}"},{"id":"432189f4-b507-40b7-ab6d-f71e8f668898","name":"Bad Request. please contact support!","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"name\": \"John Deo\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+18887324197\",\n \"dateOfBirth\": \"1990-09-25\",\n \"address1\": \"3535 1st St N\",\n \"city\": \"Dolomite\",\n \"state\": \"AL\",\n \"country\": \"US\",\n \"postalCode\": \"35061\",\n \"companyName\": \"DGS VolMAX\",\n \"website\": \"35061\",\n \"tags\": [\n \"ea deserunt culpa laboris\",\n \"quis in veniam qui\"\n ],\n \"source\": \"public api\",\n \"customField\": {\n \"__custom_field_id__\": \"ea d\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:id","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":id"],"variable":[{"key":"id","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Contact Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"888a6d32-304b-489a-a871-ac58a683ee01","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"name\": \"John Deo\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+18887324197\",\n \"dateOfBirth\": \"1990-09-25\",\n \"address1\": \"3535 1st St N\",\n \"city\": \"Dolomite\",\n \"state\": \"AL\",\n \"country\": \"US\",\n \"postalCode\": \"35061\",\n \"companyName\": \"DGS VolMAX\",\n \"website\": \"35061\",\n \"tags\": [\n \"ea deserunt culpa laboris\",\n \"quis in veniam qui\"\n ],\n \"source\": \"public api\",\n \"customField\": {\n \"__custom_field_id__\": \"ea d\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:id","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":id"],"variable":[{"key":"id","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Contact Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"d66d397c-4c59-4a24-9885-3555cf942d9d","name":"Unprocessable Entity","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"name\": \"John Deo\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+18887324197\",\n \"dateOfBirth\": \"1990-09-25\",\n \"address1\": \"3535 1st St N\",\n \"city\": \"Dolomite\",\n \"state\": \"AL\",\n \"country\": \"US\",\n \"postalCode\": \"35061\",\n \"companyName\": \"DGS VolMAX\",\n \"website\": \"35061\",\n \"tags\": [\n \"ea deserunt culpa laboris\",\n \"quis in veniam qui\"\n ],\n \"source\": \"public api\",\n \"customField\": {\n \"__custom_field_id__\": \"ea d\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:id","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":id"],"variable":[{"key":"id","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Contact Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": {\n \"message\": \"The contact id is invalid.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"1c7060e2-ebaf-4b5b-9248-be0292689bba"},{"name":"/v1/contacts/:id","id":"546cdf6c-3367-4569-b3c4-46d9f13a71ba","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"DELETE","header":[],"url":"https://rest.gohighlevel.com/v1/contacts/:id","description":"

Delete contact by id.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","contacts",":id"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"4cd03e86-2a71-4381-bac5-366f3438b626","description":{"content":"

(Required) Contact Id

\n","type":"text/plain"},"type":"any","value":"ocQHyuzHvysMo5N5VsXc","key":"id"}]}},"response":[{"id":"7956999e-933a-4b97-9e60-c5cad10c9c00","name":"Successful response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:id","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":id"],"variable":[{"key":"id","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Contact Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"18666960-2c40-40a1-8c91-28d845a3e0e0","name":"Bad Request. please contact support!","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:id","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":id"],"variable":[{"key":"id","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Contact Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"04e1935f-45db-487f-b1fd-81d75a055998","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:id","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":id"],"variable":[{"key":"id","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Contact Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"634945e0-4a41-4362-891c-16d4c1b328b9","name":"Unprocessable Entity","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:id","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":id"],"variable":[{"key":"id","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Contact Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": {\n \"message\": \"The contact id is invalid.\",\n \"rule\": \"invalid\"\n }\n}"}],"_postman_id":"546cdf6c-3367-4569-b3c4-46d9f13a71ba"}],"id":"0097b747-33c2-452f-8c78-aab5ab36c071","description":"

Contact create or update.

\n","_postman_id":"0097b747-33c2-452f-8c78-aab5ab36c071","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","name":"GoHighLevel API V1.1.20","type":"collection"}}},{"name":"Custom Field","item":[{"name":"/v1/custom-fields/","id":"fd1b5421-6cca-4ad3-a062-c087f6051923","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/custom-fields/","description":"

Get all available custom fields.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","custom-fields",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[]}},"response":[{"id":"d1f28a2f-bc5d-4fa2-af2a-87ccdd1c45b0","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/custom-fields/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"customFields\": [\n {\n \"id\": \"ocQHyuzHvysMo5N5VsXc\",\n \"name\": \"Select\",\n \"fieldKey\": \"contact.select\",\n \"placeholder\": \"Placeholder Text\",\n \"position\": 0,\n \"dateType\": \"SINGLE_OPTIONS\",\n \"picklistOptions\": [\n \"first\",\n \"first\"\n ]\n },\n {\n \"id\": \"ocQHyuzHvysMo5N5VsXc\",\n \"name\": \"Select\",\n \"fieldKey\": \"contact.select\",\n \"placeholder\": \"Placeholder Text\",\n \"position\": 0,\n \"dateType\": \"SINGLE_OPTIONS\",\n \"picklistOptions\": [\n \"first\",\n \"first\"\n ]\n }\n ]\n}"},{"id":"f79d4570-d95b-4087-a647-5bd9ae1574f2","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/custom-fields/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"52e86d40-869b-4493-be7a-4af520967478","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/custom-fields/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"fd1b5421-6cca-4ad3-a062-c087f6051923"},{"name":"/v1/custom-fields/","id":"bb207d3a-0b10-4e90-9449-78f72193325c","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Custom Field\",\n \"dataType\": \"TEXT\",\n \"placeholder\": \"Placeholder Text\",\n \"options\": [\n \"first option\",\n \"last option\"\n ],\n \"acceptedFormat\": [\n \".pdf\",\n \".docx\",\n \".jpeg\"\n ],\n \"isMultipalFile\": false,\n \"maxNumberOfFiles\": 2,\n \"textBoxListOptions\": [\n {\n \"label\": \"First\",\n \"prefillValue\": \"\"\n },\n {\n \"label\": \"First\",\n \"prefillValue\": \"\"\n }\n ],\n \"position\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/custom-fields/","description":"

Creating Custom Field.

Data Type Fields will allow these options. ex:

Options:
  • TEXT
  • LARGE_TEXT
  • NUMERICAL
  • PHONE
  • MONETORY
  • CHECKBOX
  • SINGLE_OPTIONS
  • MULTIPLE_OPTIONS
  • FLOAT
  • TIME
  • DATE
  • TEXTBOX_LIST
  • FILE_UPLOAD
  • SIGNATURE
Validation:

Name and Date Type are required to create every custom field.

On every data type of field have diffrent validation rules. These are the different validation rules.

FILE_UPLOAD:
  • acceptedFormat *(required) This will allow array of file format.
    • .pdf
    • .docx
    • .jpeg
    • .png
    • .gif
    • .csv
    • all
  • isMulitpalFile (optional) it allow true or false. If you want to allow multipal files pass true
  • maxNumberOfFiles (options) It will allow maximum these number of files.
SINGLE_OPTIONS / MULTIPLE_OPTIONS / CHECKBOX:
  • options *(required) This will allow array of options.
TEXTBOX_LIST
  • textBoxListOptions: (required) This will allow array of textbox list. Array will contanis label and prefillValue. ex.: {label\": \"Hello\", \"prefillValue\": \"value\"}
Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","custom-fields",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[]}},"response":[{"id":"f4a4d011-34a3-452d-acc3-c4a3c1850d89","name":"Successful response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"Custom Field\",\n \"dataType\": \"TEXT\",\n \"placeholder\": \"Placeholder Text\",\n \"options\": [\n \"first option\",\n \"last option\"\n ],\n \"acceptedFormat\": [\n \".pdf\",\n \".docx\",\n \".jpeg\"\n ],\n \"isMultipalFile\": false,\n \"maxNumberOfFiles\": 2,\n \"textBoxListOptions\": [\n {\n \"label\": \"First\",\n \"prefillValue\": \"\"\n },\n {\n \"label\": \"First\",\n \"prefillValue\": \"\"\n }\n ],\n \"position\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/custom-fields/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"ocQHyuzHvysMo5N5VsXc\",\n \"name\": \"Select\",\n \"fieldKey\": \"contact.select\",\n \"placeholder\": \"Placeholder Text\",\n \"position\": 0,\n \"dateType\": \"SINGLE_OPTIONS\",\n \"picklistOptions\": [\n \"first\",\n \"first\"\n ]\n}"},{"id":"a4fde0bf-a1ef-48ff-a9b3-5d50b6940cbe","name":"Bad Request. please contact support!","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"Custom Field\",\n \"dataType\": \"TEXT\",\n \"placeholder\": \"Placeholder Text\",\n \"options\": [\n \"first option\",\n \"last option\"\n ],\n \"acceptedFormat\": [\n \".pdf\",\n \".docx\",\n \".jpeg\"\n ],\n \"isMultipalFile\": false,\n \"maxNumberOfFiles\": 2,\n \"textBoxListOptions\": [\n {\n \"label\": \"First\",\n \"prefillValue\": \"\"\n },\n {\n \"label\": \"First\",\n \"prefillValue\": \"\"\n }\n ],\n \"position\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/custom-fields/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"e44b8124-ef94-442f-9d18-78998671a41f","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"Custom Field\",\n \"dataType\": \"TEXT\",\n \"placeholder\": \"Placeholder Text\",\n \"options\": [\n \"first option\",\n \"last option\"\n ],\n \"acceptedFormat\": [\n \".pdf\",\n \".docx\",\n \".jpeg\"\n ],\n \"isMultipalFile\": false,\n \"maxNumberOfFiles\": 2,\n \"textBoxListOptions\": [\n {\n \"label\": \"First\",\n \"prefillValue\": \"\"\n },\n {\n \"label\": \"First\",\n \"prefillValue\": \"\"\n }\n ],\n \"position\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/custom-fields/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"360d2985-a266-4cd1-9edd-32f9c4379507","name":"Unprocessable Entity","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"Custom Field\",\n \"dataType\": \"TEXT\",\n \"placeholder\": \"Placeholder Text\",\n \"options\": [\n \"first option\",\n \"last option\"\n ],\n \"acceptedFormat\": [\n \".pdf\",\n \".docx\",\n \".jpeg\"\n ],\n \"isMultipalFile\": false,\n \"maxNumberOfFiles\": 2,\n \"textBoxListOptions\": [\n {\n \"label\": \"First\",\n \"prefillValue\": \"\"\n },\n {\n \"label\": \"First\",\n \"prefillValue\": \"\"\n }\n ],\n \"position\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/custom-fields/"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": {\n \"message\": \"The name field is mandatory.\",\n \"rule\": \"required\"\n },\n \"dataType\": {\n \"message\": \"The data type field is mandatory.\",\n \"rule\": \"required\"\n },\n \"options or acceptedFormat or textBoxListOptions\": {\n \"message\": \"The options or acceptedFormat or textBoxListOptions field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"bb207d3a-0b10-4e90-9449-78f72193325c"},{"name":"/v1/custom-fields/:customFieldId","id":"8a77bff2-7368-411c-8274-0492c883fe1e","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/custom-fields/:customFieldId","description":"

Get custom fields by id

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","custom-fields",":customFieldId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"1126ae6e-d940-4cbf-8679-81e21a581022","description":{"content":"

(Required) Custom Field Id

\n","type":"text/plain"},"type":"any","value":"ocQHyuzHvysMo5N5VsXc","key":"customFieldId"}]}},"response":[{"id":"b3a23f0c-ca8b-4501-884e-e6a56f992108","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/custom-fields/:customFieldId","host":["https://rest.gohighlevel.com"],"path":["v1","custom-fields",":customFieldId"],"variable":[{"key":"customFieldId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Custom Field Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"ocQHyuzHvysMo5N5VsXc\",\n \"name\": \"Select\",\n \"fieldKey\": \"contact.select\",\n \"placeholder\": \"Placeholder Text\",\n \"position\": 0,\n \"dateType\": \"SINGLE_OPTIONS\",\n \"picklistOptions\": [\n \"first\",\n \"first\"\n ]\n}"},{"id":"ef380e58-32be-4a65-b73e-ffba7d943c11","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/custom-fields/:customFieldId","host":["https://rest.gohighlevel.com"],"path":["v1","custom-fields",":customFieldId"],"variable":[{"key":"customFieldId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Custom Field Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"84ec3876-7351-4bef-b6fc-8b879b6b830b","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/custom-fields/:customFieldId","host":["https://rest.gohighlevel.com"],"path":["v1","custom-fields",":customFieldId"],"variable":[{"key":"customFieldId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Custom Field Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"8a77bff2-7368-411c-8274-0492c883fe1e"},{"name":"/v1/custom-fields/:customFieldId","id":"8bea5229-0c9a-419d-b501-64b786680a36","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Custom Field\",\n \"dataType\": \"TEXT\",\n \"placeholder\": \"Placeholder Text\",\n \"options\": [\n \"first option\",\n \"last option\"\n ],\n \"acceptedFormat\": [\n \".pdf\",\n \".docx\",\n \".jpeg\"\n ],\n \"isMultipalFile\": false,\n \"maxNumberOfFiles\": 2,\n \"textBoxListOptions\": [\n {\n \"label\": \"First\",\n \"prefillValue\": \"\"\n },\n {\n \"label\": \"First\",\n \"prefillValue\": \"\"\n }\n ],\n \"position\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/custom-fields/:customFieldId","description":"

Updating Custom Field.

Data Type Fields will allow these options. ex:

Options:
  • TEXT
  • LARGE_TEXT
  • NUMERICAL
  • PHONE
  • MONETORY
  • CHECKBOX
  • SINGLE_OPTIONS
  • MULTIPLE_OPTIONS
  • FLOAT
  • TIME
  • DATE
  • TEXTBOX_LIST
  • FILE_UPLOAD
  • SIGNATURE
Validation:

Name and Date Type are required to create every custom field.

On every data type of field have diffrent validation rules. These are the different validation rules.

FILE_UPLOAD:
  • acceptedFormat *(required) This will allow array of file format.
    • .pdf
    • .docx
    • .jpeg
    • .png
    • .gif
    • .csv
    • all
  • isMulitpalFile (optional) it allow true or false. If you want to allow multipal files pass true
  • maxNumberOfFiles (options) It will allow maximum these number of files.
SINGLE_OPTIONS / MULTIPLE_OPTIONS / CHECKBOX:
  • options *(required) This will allow array of options.
TEXTBOX_LIST
  • textBoxListOptions: (required) This will allow array of textbox list. Array will contanis label and prefillValue. ex.: {label\": \"Hello\", \"prefillValue\": \"value\"}
Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","custom-fields",":customFieldId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"ef9c420a-d925-4c11-81b7-dd3d2ee1ec6e","description":{"content":"

(Required) Custom Field Id

\n","type":"text/plain"},"type":"any","value":"ocQHyuzHvysMo5N5VsXc","key":"customFieldId"}]}},"response":[{"id":"2d6a5ff0-596c-4f04-b829-95c615bf1f45","name":"Successful response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"Custom Field\",\n \"dataType\": \"TEXT\",\n \"placeholder\": \"Placeholder Text\",\n \"options\": [\n \"first option\",\n \"last option\"\n ],\n \"acceptedFormat\": [\n \".pdf\",\n \".docx\",\n \".jpeg\"\n ],\n \"isMultipalFile\": false,\n \"maxNumberOfFiles\": 2,\n \"textBoxListOptions\": [\n {\n \"label\": \"First\",\n \"prefillValue\": \"\"\n },\n {\n \"label\": \"First\",\n \"prefillValue\": \"\"\n }\n ],\n \"position\": 0\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/custom-fields/:customFieldId","host":["https://rest.gohighlevel.com"],"path":["v1","custom-fields",":customFieldId"],"variable":[{"key":"customFieldId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Custom Field Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"ocQHyuzHvysMo5N5VsXc\",\n \"name\": \"Select\",\n \"fieldKey\": \"contact.select\",\n \"placeholder\": \"Placeholder Text\",\n \"position\": 0,\n \"dateType\": \"SINGLE_OPTIONS\",\n \"picklistOptions\": [\n \"first\",\n \"first\"\n ]\n}"},{"id":"65ee843f-ac2f-44db-8d39-c752237c1366","name":"Bad Request. please contact support!","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"Custom Field\",\n \"dataType\": \"TEXT\",\n \"placeholder\": \"Placeholder Text\",\n \"options\": [\n \"first option\",\n \"last option\"\n ],\n \"acceptedFormat\": [\n \".pdf\",\n \".docx\",\n \".jpeg\"\n ],\n \"isMultipalFile\": false,\n \"maxNumberOfFiles\": 2,\n \"textBoxListOptions\": [\n {\n \"label\": \"First\",\n \"prefillValue\": \"\"\n },\n {\n \"label\": \"First\",\n \"prefillValue\": \"\"\n }\n ],\n \"position\": 0\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/custom-fields/:customFieldId","host":["https://rest.gohighlevel.com"],"path":["v1","custom-fields",":customFieldId"],"variable":[{"key":"customFieldId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Custom Field Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"c5ca19bd-da9a-4fbb-b9c1-a861743eac81","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"Custom Field\",\n \"dataType\": \"TEXT\",\n \"placeholder\": \"Placeholder Text\",\n \"options\": [\n \"first option\",\n \"last option\"\n ],\n \"acceptedFormat\": [\n \".pdf\",\n \".docx\",\n \".jpeg\"\n ],\n \"isMultipalFile\": false,\n \"maxNumberOfFiles\": 2,\n \"textBoxListOptions\": [\n {\n \"label\": \"First\",\n \"prefillValue\": \"\"\n },\n {\n \"label\": \"First\",\n \"prefillValue\": \"\"\n }\n ],\n \"position\": 0\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/custom-fields/:customFieldId","host":["https://rest.gohighlevel.com"],"path":["v1","custom-fields",":customFieldId"],"variable":[{"key":"customFieldId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Custom Field Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"70b4c565-ed33-4b46-8b92-1a3dfc57ab63","name":"Unprocessable Entity","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"Custom Field\",\n \"dataType\": \"TEXT\",\n \"placeholder\": \"Placeholder Text\",\n \"options\": [\n \"first option\",\n \"last option\"\n ],\n \"acceptedFormat\": [\n \".pdf\",\n \".docx\",\n \".jpeg\"\n ],\n \"isMultipalFile\": false,\n \"maxNumberOfFiles\": 2,\n \"textBoxListOptions\": [\n {\n \"label\": \"First\",\n \"prefillValue\": \"\"\n },\n {\n \"label\": \"First\",\n \"prefillValue\": \"\"\n }\n ],\n \"position\": 0\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/custom-fields/:customFieldId","host":["https://rest.gohighlevel.com"],"path":["v1","custom-fields",":customFieldId"],"variable":[{"key":"customFieldId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Custom Field Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": {\n \"message\": \"The name field is mandatory.\",\n \"rule\": \"required\"\n },\n \"dataType\": {\n \"message\": \"The data type field is mandatory.\",\n \"rule\": \"required\"\n },\n \"options or acceptedFormat or textBoxListOptions\": {\n \"message\": \"The options or acceptedFormat or textBoxListOptions field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"8bea5229-0c9a-419d-b501-64b786680a36"},{"name":"/v1/custom-fields/:customFieldId","id":"56c9f821-fd68-4ba2-914a-b8f262665304","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"DELETE","header":[],"url":"https://rest.gohighlevel.com/v1/custom-fields/:customFieldId","description":"

Delete one of custom fields.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","custom-fields",":customFieldId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"06e99ae6-f211-42b8-9611-90a6b26ab852","description":{"content":"

(Required) Custom Field Id

\n","type":"text/plain"},"type":"any","value":"ocQHyuzHvysMo5N5VsXc","key":"customFieldId"}]}},"response":[{"id":"53e64e9d-c95a-4188-8834-f4b72f298080","name":"Successful response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/custom-fields/:customFieldId","host":["https://rest.gohighlevel.com"],"path":["v1","custom-fields",":customFieldId"],"variable":[{"key":"customFieldId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Custom Field Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"\"\""},{"id":"0556127a-dc09-4ee7-98af-2acdbf013e70","name":"Bad Request. please contact support!","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/custom-fields/:customFieldId","host":["https://rest.gohighlevel.com"],"path":["v1","custom-fields",":customFieldId"],"variable":[{"key":"customFieldId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Custom Field Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"46bb7389-0721-4cee-893e-4c5e75196fd0","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/custom-fields/:customFieldId","host":["https://rest.gohighlevel.com"],"path":["v1","custom-fields",":customFieldId"],"variable":[{"key":"customFieldId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Custom Field Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"e9f04d28-2a75-43da-92d1-9f2d4fb7d0bd","name":"Unprocessable Entity","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/custom-fields/:customFieldId","host":["https://rest.gohighlevel.com"],"path":["v1","custom-fields",":customFieldId"],"variable":[{"key":"customFieldId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Custom Field Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"customFieldId\": {\n \"message\": \"The custom field id is invalid.\",\n \"rule\": \"invalid\"\n }\n}"}],"_postman_id":"56c9f821-fd68-4ba2-914a-b8f262665304"}],"id":"92a89f08-2647-4eaa-bb18-0aa32a8e67c2","_postman_id":"92a89f08-2647-4eaa-bb18-0aa32a8e67c2","description":"","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","name":"GoHighLevel API V1.1.20","type":"collection"}}},{"name":"Custom Value","item":[{"name":"/v1/custom-values/","id":"11fa3957-4a52-4170-bf49-6b6810981eff","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/custom-values/","description":"

Get all available custom values.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","custom-values",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[]}},"response":[{"id":"c6a6f544-1334-4cd9-9e35-68e34874edd9","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/custom-values/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"customFields\": [\n {\n \"id\": \"ocQHyuzHvysMo5N5VsXc\",\n \"name\": \"Select\",\n \"fieldKey\": \"{{ custom_value.test }}\",\n \"value\": \"test\"\n },\n {\n \"id\": \"ocQHyuzHvysMo5N5VsXc\",\n \"name\": \"Select\",\n \"fieldKey\": \"{{ custom_value.test }}\",\n \"value\": \"test\"\n }\n ]\n}"},{"id":"2e2191a4-9048-4d4d-9c73-6958e9720a90","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/custom-values/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"7b8523ec-a464-402c-9eca-0b7121368238","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/custom-values/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"11fa3957-4a52-4170-bf49-6b6810981eff"},{"name":"/v1/custom-values/","id":"05bf3151-f64c-4002-a223-ca7a4d2eb476","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Custom Field\",\n \"value\": \"Value\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/custom-values/","description":"

Create custom value.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","custom-values",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[]}},"response":[{"id":"acc099a6-eb10-4ee2-9efd-6547349db661","name":"Successful response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"Custom Field\",\n \"value\": \"Value\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/custom-values/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"ocQHyuzHvysMo5N5VsXc\",\n \"name\": \"Select\",\n \"fieldKey\": \"{{ custom_value.test }}\",\n \"value\": \"test\"\n}"},{"id":"f9216a3e-c189-4cfd-a320-a015bd487bff","name":"Bad Request. please contact support!","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"Custom Field\",\n \"value\": \"Value\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/custom-values/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"35e8a7dc-6db0-40e6-ba9b-e23222a65189","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"Custom Field\",\n \"value\": \"Value\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/custom-values/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"49aa917a-3e2f-4a59-ba39-41162309395f","name":"Unprocessable Entity","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"Custom Field\",\n \"value\": \"Value\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/custom-values/"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": {\n \"message\": \"The name field is mandatory.\",\n \"rule\": \"required\"\n },\n \"value\": {\n \"message\": \"The value field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"05bf3151-f64c-4002-a223-ca7a4d2eb476"},{"name":"/v1/custom-values/:customValueId","id":"e90fa923-183e-44df-9b24-851641d6ac3f","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/custom-values/:customValueId","description":"

Get custom value by id.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","custom-values",":customValueId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"0ca3fb2d-ee5c-4bc4-b857-f2646f395414","description":{"content":"

(Required) Custom Value Id

\n","type":"text/plain"},"type":"any","value":"ocQHyuzHvysMo5N5VsXc","key":"customValueId"}]}},"response":[{"id":"d41e7cf0-dafa-46e9-85fd-fb44a114d69d","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/custom-values/:customValueId","host":["https://rest.gohighlevel.com"],"path":["v1","custom-values",":customValueId"],"variable":[{"key":"customValueId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Custom Value Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"ocQHyuzHvysMo5N5VsXc\",\n \"name\": \"Select\",\n \"fieldKey\": \"{{ custom_value.test }}\",\n \"value\": \"test\"\n}"},{"id":"260d55de-5a34-4d12-98c2-1082dcbc9cfb","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/custom-values/:customValueId","host":["https://rest.gohighlevel.com"],"path":["v1","custom-values",":customValueId"],"variable":[{"key":"customValueId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Custom Value Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"060e8883-4d1f-4f6f-b384-bae39e47ebef","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/custom-values/:customValueId","host":["https://rest.gohighlevel.com"],"path":["v1","custom-values",":customValueId"],"variable":[{"key":"customValueId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Custom Value Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"e90fa923-183e-44df-9b24-851641d6ac3f"},{"name":"/v1/custom-values/:customValueId","id":"bc0b2d43-def4-4bcd-9381-18190f0b456c","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Custom Field\",\n \"value\": \"Value\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/custom-values/:customValueId","description":"

Update custom value.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","custom-values",":customValueId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"bf04d5d4-500a-4098-a73d-1910283fee17","description":{"content":"

(Required) Custom Value Id

\n","type":"text/plain"},"type":"any","value":"ocQHyuzHvysMo5N5VsXc","key":"customValueId"}]}},"response":[{"id":"452c25f3-a554-4ed8-b15c-901ab08d5ab3","name":"Successful response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"Custom Field\",\n \"value\": \"Value\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/custom-values/:customValueId","host":["https://rest.gohighlevel.com"],"path":["v1","custom-values",":customValueId"],"variable":[{"key":"customValueId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Custom Value Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"ocQHyuzHvysMo5N5VsXc\",\n \"name\": \"Select\",\n \"fieldKey\": \"{{ custom_value.test }}\",\n \"value\": \"test\"\n}"},{"id":"e99ea2d5-60ab-46e5-8249-7dd13df6d6fe","name":"Bad Request. please contact support!","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"Custom Field\",\n \"value\": \"Value\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/custom-values/:customValueId","host":["https://rest.gohighlevel.com"],"path":["v1","custom-values",":customValueId"],"variable":[{"key":"customValueId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Custom Value Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"58d786b2-94e8-4b12-a185-cbddcce400a0","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"Custom Field\",\n \"value\": \"Value\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/custom-values/:customValueId","host":["https://rest.gohighlevel.com"],"path":["v1","custom-values",":customValueId"],"variable":[{"key":"customValueId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Custom Value Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"a58bd6ef-fc6d-4206-a4b9-974b62c772f7","name":"Unprocessable Entity","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"Custom Field\",\n \"value\": \"Value\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/custom-values/:customValueId","host":["https://rest.gohighlevel.com"],"path":["v1","custom-values",":customValueId"],"variable":[{"key":"customValueId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Custom Value Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": {\n \"message\": \"The name field is mandatory.\",\n \"rule\": \"required\"\n },\n \"value\": {\n \"message\": \"The value field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"bc0b2d43-def4-4bcd-9381-18190f0b456c"},{"name":"/v1/custom-values/:customValueId","id":"b44d29ac-a0ad-464a-9faf-d4c579bbc6c4","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"DELETE","header":[],"url":"https://rest.gohighlevel.com/v1/custom-values/:customValueId","description":"

Delete one of custom value.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","custom-values",":customValueId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"740d6620-cba1-40ba-bcf2-56fc47319f01","description":{"content":"

(Required) Custom Value Id

\n","type":"text/plain"},"type":"any","value":"ocQHyuzHvysMo5N5VsXc","key":"customValueId"}]}},"response":[{"id":"768d865a-1b0e-4e63-a9dd-55c46f1d5c15","name":"Successful response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/custom-values/:customValueId","host":["https://rest.gohighlevel.com"],"path":["v1","custom-values",":customValueId"],"variable":[{"key":"customValueId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Custom Value Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"\"\""},{"id":"efb4ae91-107d-468a-9988-ce70653521ed","name":"Bad Request. please contact support!","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/custom-values/:customValueId","host":["https://rest.gohighlevel.com"],"path":["v1","custom-values",":customValueId"],"variable":[{"key":"customValueId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Custom Value Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"893f77ff-7eef-4f37-9f13-316e533821c4","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/custom-values/:customValueId","host":["https://rest.gohighlevel.com"],"path":["v1","custom-values",":customValueId"],"variable":[{"key":"customValueId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Custom Value Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"b636ed80-9605-47f6-a57f-a6ec9ab5d1fb","name":"Unprocessable Entity","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/custom-values/:customValueId","host":["https://rest.gohighlevel.com"],"path":["v1","custom-values",":customValueId"],"variable":[{"key":"customValueId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Custom Value Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"customValueId\": {\n \"message\": \"The custom field id is invalid.\",\n \"rule\": \"invalid\"\n }\n}"}],"_postman_id":"b44d29ac-a0ad-464a-9faf-d4c579bbc6c4"}],"id":"857cd6cd-2b8f-4fee-9f26-267eda31729f","_postman_id":"857cd6cd-2b8f-4fee-9f26-267eda31729f","description":"","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","name":"GoHighLevel API V1.1.20","type":"collection"}}},{"name":"Form","item":[{"name":"/v1/forms/","id":"29a44f93-8ec3-464d-a2d2-a3bce3d70ffc","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/forms/","description":"

Get Forms.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","forms",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[]}},"response":[{"id":"c1f9b763-9bfa-48a2-a381-f4760f0114b0","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/forms/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"forms\": [\n {\n \"id\": \"uP9CBUzKKZkP5BtkHeK3\",\n \"name\": \"Form 1\"\n },\n {\n \"id\": \"uP9CBUzKKZkP5BtkHeK3\",\n \"name\": \"Form 1\"\n }\n ]\n}"},{"id":"6583d875-bbcc-4486-8ded-b29476f3f3b4","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/forms/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"840bbbf8-c82d-44af-acfa-e59716d955f5","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/forms/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"29a44f93-8ec3-464d-a2d2-a3bce3d70ffc"},{"name":"/v1/forms/submissions","id":"74389c69-5f81-4d4f-bd0c-7f9e884225e2","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/forms/submissions?page=1&limit=20&formId=jjusM6EOngDExnbo2DbU&q=john@deo.com&startAt=2020-11-14&endAt=2020-12-14","description":"

Get form submissions.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","forms","submissions"],"host":["https://rest.gohighlevel.com"],"query":[{"description":{"content":"

Page No. By default it will be 1

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Limit Per Page records count. will allow maximum up to 100 and default will be 20

\n","type":"text/plain"},"key":"limit","value":"20"},{"description":{"content":"

Filter submission by form id

\n","type":"text/plain"},"key":"formId","value":"jjusM6EOngDExnbo2DbU"},{"description":{"content":"

Filter by contactId, name, email or phone no.

\n","type":"text/plain"},"key":"q","value":"john@deo.com"},{"description":{"content":"

Get submission by starting of this date. By default it will be same date of last month.

\n","type":"text/plain"},"key":"startAt","value":"2020-11-14"},{"description":{"content":"

Get submission by ending of this date. By default it will be current date.

\n","type":"text/plain"},"key":"endAt","value":"2020-12-14"}],"variable":[]}},"response":[{"id":"39108ef5-c154-4a32-b1cc-d529f550b049","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/forms/submissions?page=1&limit=20&formId=jjusM6EOngDExnbo2DbU&q=john@deo.com&startAt=2020-11-14&endAt=2020-12-14","host":["https://rest.gohighlevel.com"],"path":["v1","forms","submissions"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"20"},{"key":"formId","value":"jjusM6EOngDExnbo2DbU"},{"key":"q","value":"john@deo.com"},{"key":"startAt","value":"2020-11-14"},{"key":"endAt","value":"2020-12-14"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"submissions\": [\n {\n \"id\": \"be759b9a-c3ec-4b29-ba07-fc3c89c77673\",\n \"contactId\": \"9NkT25Vor1v4aQatFsv2\",\n \"__submissions_other_field__\": \"john@deo.com\",\n \"__custom_field_id__\": \"20\",\n \"createdAt\": \"2020-11-01T18:02:21.000Z\",\n \"formId\": \"jjusM6EOngDExnbo2DbU\",\n \"pageDetails\": {\n \"url\": \"https://www.gohighlevel.com/\",\n \"source\": \"Social Media\",\n \"referrer\": \"http://m.facebook.com\",\n \"fbclid\": \"IwAR1JoTTltt3EKJE3O-MrQij_lTeA6BKGTy8M2wKepSzs4oUbTYhL2Lns18w\"\n }\n },\n {\n \"id\": \"be759b9a-c3ec-4b29-ba07-fc3c89c77673\",\n \"contactId\": \"9NkT25Vor1v4aQatFsv2\",\n \"__submissions_other_field__\": \"john@deo.com\",\n \"__custom_field_id__\": \"20\",\n \"createdAt\": \"2020-11-01T18:02:21.000Z\",\n \"formId\": \"jjusM6EOngDExnbo2DbU\",\n \"pageDetails\": {\n \"url\": \"https://www.gohighlevel.com/\",\n \"source\": \"Social Media\",\n \"referrer\": \"http://m.facebook.com\",\n \"fbclid\": \"IwAR1JoTTltt3EKJE3O-MrQij_lTeA6BKGTy8M2wKepSzs4oUbTYhL2Lns18w\"\n }\n }\n ],\n \"meta\": {\n \"total\": 250,\n \"currentPage\": 2,\n \"nextPage\": 3,\n \"prevPage\": 1\n }\n}"},{"id":"7b821e86-0367-413c-b9dc-b503a9c78ae0","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/forms/submissions?page=1&limit=20&formId=jjusM6EOngDExnbo2DbU&q=john@deo.com&startAt=2020-11-14&endAt=2020-12-14","host":["https://rest.gohighlevel.com"],"path":["v1","forms","submissions"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"20"},{"key":"formId","value":"jjusM6EOngDExnbo2DbU"},{"key":"q","value":"john@deo.com"},{"key":"startAt","value":"2020-11-14"},{"key":"endAt","value":"2020-12-14"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"6efa5c9b-a45e-400b-993f-ddeec83f29cf","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/forms/submissions?page=1&limit=20&formId=jjusM6EOngDExnbo2DbU&q=john@deo.com&startAt=2020-11-14&endAt=2020-12-14","host":["https://rest.gohighlevel.com"],"path":["v1","forms","submissions"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"20"},{"key":"formId","value":"jjusM6EOngDExnbo2DbU"},{"key":"q","value":"john@deo.com"},{"key":"startAt","value":"2020-11-14"},{"key":"endAt","value":"2020-12-14"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"74389c69-5f81-4d4f-bd0c-7f9e884225e2"}],"id":"261674a4-9d08-4f4e-89ca-69a718ba0d30","_postman_id":"261674a4-9d08-4f4e-89ca-69a718ba0d30","description":"","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","name":"GoHighLevel API V1.1.20","type":"collection"}}},{"name":"Location","item":[{"name":"/v1/locations/","id":"b2157151-366b-4625-b1f8-d77458d0cf9f","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/locations/","description":"

Get all agency location.

Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys

","urlObject":{"path":["v1","locations",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[]}},"response":[{"id":"914beafd-fac3-48ad-9677-44c4c2429a6c","name":"Successful response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":"https://rest.gohighlevel.com/v1/locations/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"locations\": [\n {\n \"id\": \"i2SpAtBVHSVea1sL6oah\",\n \"name\": \"Tesla inc\",\n \"address\": \"3500 Deer Creek Road\",\n \"city\": \"Palo Alto\",\n \"country\": \"US\",\n \"state\": \"CA\",\n \"postalCode\": \"94304\",\n \"website\": \"https://www.tesla.com\",\n \"timezone\": \"US/Central\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+1202-555-0107\",\n \"business\": {\n \"name\": \"Tesla inc\",\n \"address\": \"3500 Deer Creek Road\",\n \"city\": \"Palo Alto\",\n \"country\": \"US\",\n \"state\": \"CA\",\n \"postalCode\": \"94304\",\n \"website\": \"https://www.tesla.com\",\n \"timezone\": \"US/Central\"\n },\n \"social\": {\n \"facebookUrl\": \"https://facebook.com/groups/XXX\",\n \"googlePlus\": \"https://groups.google.com/d/XXX\",\n \"linkedIn\": \"https://www.linkedin.com/groups/XXX/profile\",\n \"foursquare\": \"https://foursquare.com/groups/XXX\",\n \"twitter\": \"https://twitter.com/XXX\",\n \"yelp\": \"https://yelp.com/XXX\",\n \"instagram\": \"https://instagram.com/XXX\",\n \"youtube\": \"https://youtube.com/XXX\",\n \"pinterest\": \"https://pinterest.com/XXX\",\n \"blogRss\": \"https://rss.xyz.com\",\n \"googlePlaceId\": \"redfdfdere\"\n },\n \"settings\": {\n \"allowDuplicateContact\": false,\n \"allowDuplicateOpportunity\": false,\n \"allowFacebookNameMerge\": false,\n \"disableContactTimezone\": false\n }\n },\n {\n \"id\": \"i2SpAtBVHSVea1sL6oah\",\n \"name\": \"Tesla inc\",\n \"address\": \"3500 Deer Creek Road\",\n \"city\": \"Palo Alto\",\n \"country\": \"US\",\n \"state\": \"CA\",\n \"postalCode\": \"94304\",\n \"website\": \"https://www.tesla.com\",\n \"timezone\": \"US/Central\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+1202-555-0107\",\n \"business\": {\n \"name\": \"Tesla inc\",\n \"address\": \"3500 Deer Creek Road\",\n \"city\": \"Palo Alto\",\n \"country\": \"US\",\n \"state\": \"CA\",\n \"postalCode\": \"94304\",\n \"website\": \"https://www.tesla.com\",\n \"timezone\": \"US/Central\"\n },\n \"social\": {\n \"facebookUrl\": \"https://facebook.com/groups/XXX\",\n \"googlePlus\": \"https://groups.google.com/d/XXX\",\n \"linkedIn\": \"https://www.linkedin.com/groups/XXX/profile\",\n \"foursquare\": \"https://foursquare.com/groups/XXX\",\n \"twitter\": \"https://twitter.com/XXX\",\n \"yelp\": \"https://yelp.com/XXX\",\n \"instagram\": \"https://instagram.com/XXX\",\n \"youtube\": \"https://youtube.com/XXX\",\n \"pinterest\": \"https://pinterest.com/XXX\",\n \"blogRss\": \"https://rss.xyz.com\",\n \"googlePlaceId\": \"redfdfdere\"\n },\n \"settings\": {\n \"allowDuplicateContact\": false,\n \"allowDuplicateOpportunity\": false,\n \"allowFacebookNameMerge\": false,\n \"disableContactTimezone\": false\n }\n }\n ]\n}"},{"id":"e67fdddc-39cb-4771-85cf-f924263f89b3","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/locations/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"8779c3a6-17c8-49cd-8c13-b01911d0584d","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/locations/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"b2157151-366b-4625-b1f8-d77458d0cf9f"},{"name":"/v1/locations/","id":"2be923cc-fcbf-466a-8d8e-ff5ee1cfc244","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"businessName\": \"Tesla inc\",\n \"address\": \"3500 Deer Creek Road\",\n \"city\": \"Palo Alto\",\n \"country\": \"US\",\n \"state\": \"CA\",\n \"postalCode\": \"94304\",\n \"website\": \"https://www.tesla.com\",\n \"timezone\": \"US/Central\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+1202-555-0107\",\n \"settings\": {\n \"allowDuplicateContact\": false,\n \"allowDuplicateOpportunity\": false,\n \"allowFacebookNameMerge\": false,\n \"disableContactTimezone\": false\n },\n \"twilio\": {\n \"sid\": \"AC_XXXXXXXXXXX\",\n \"authToken\": \"77_XXXXXXXXXXX\"\n },\n \"snapshot\": {\n \"id\": \"XXXXXXXXXXX\",\n \"type\": \"vertical\"\n },\n \"mailgun\": {\n \"apiKey\": \"key-XXXXXXXXXXX\",\n \"domain\": \"replies.yourdomain.com\"\n },\n \"social\": {\n \"facebookUrl\": \"https://facebook.com/groups/XXX\",\n \"googlePlus\": \"https://groups.google.com/d/XXX\",\n \"linkedIn\": \"https://www.linkedin.com/groups/XXX/profile\",\n \"foursquare\": \"https://foursquare.com/groups/XXX\",\n \"twitter\": \"https://twitter.com/XXX\",\n \"yelp\": \"https://yelp.com/XXX\",\n \"instagram\": \"https://instagram.com/XXX\",\n \"youtube\": \"https://youtube.com/XXX\",\n \"pinterest\": \"https://pinterest.com/XXX\",\n \"blogRss\": \"https://rss.xyz.com\",\n \"googlePlaceId\": \"redfdfdere\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/locations/","description":"

Create a Location.

Required JSON fields in the body

FieldsTypesExample
businessNamestringACME Agency

Allowed JSON fields in the body

FieldsTypesExample
addressstring3500 Deer Creek Road
citystringPalo Alto
statestringCA
countrystringUS
postalCodestring94304
websitestringhttps://www.tesla.com
timezonestringUS/Central
firstNamestringJohn
lastNamestringDeno
emailstringjohndeo@gmail.com
phonestring+1202-555-0107
settingsobject{ \"allowDuplicateContact\": false, \"allowDuplicateOpportunity\": false, \"allowFacebookNameMerge\": false, \"disableContactTimezone\": false }
twilioobject{ \"sid\": \"AC_XXXXXXXXXXX\", \"authToken\": \"77_XXXXXXXXXXX\" }
snapshotobject{ \"id\": \"XXXXXXXXXXX\", \"type\": \"vertical\" }
mailgunobject{\"mailgun\": {\"apiKey\": \"key-XXXXXXXXXXX\", \"domain\": \"replies.yourdomain.com\"}

Twilio field required two field to setup

FieldsTypesExample
sidstringAC_XXXXXXXXXXX (Twilio Account SID)
authTokenstring77_XXXXXXXXXXX (Twilio Auth Token)

Snapshot field required two field to import

FieldsTypesExampleAllowed Option
idstringXXXXXXXXXXX (Find it from snapshot api)
typestringown
  • own
  • imported

Mailgun field required two field to setup

FieldsTypesExample
apiKeystringkey-XXXXXXXXXXX
domainstringreplies.yourdomain.com

Timezone field allowed options, Can grab it from the timezone list api.


Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys

","urlObject":{"path":["v1","locations",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[]}},"response":[{"id":"fc5f0f8b-b931-4666-8757-bb90fdfea9bd","name":"Successful response","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"businessName\": \"Tesla inc\",\n \"address\": \"3500 Deer Creek Road\",\n \"city\": \"Palo Alto\",\n \"country\": \"US\",\n \"state\": \"CA\",\n \"postalCode\": \"94304\",\n \"website\": \"https://www.tesla.com\",\n \"timezone\": \"US/Central\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+1202-555-0107\",\n \"settings\": {\n \"allowDuplicateContact\": false,\n \"allowDuplicateOpportunity\": false,\n \"allowFacebookNameMerge\": false,\n \"disableContactTimezone\": false\n },\n \"twilio\": {\n \"sid\": \"AC_XXXXXXXXXXX\",\n \"authToken\": \"77_XXXXXXXXXXX\"\n },\n \"snapshot\": {\n \"id\": \"XXXXXXXXXXX\",\n \"type\": \"vertical\"\n },\n \"mailgun\": {\n \"apiKey\": \"key-XXXXXXXXXXX\",\n \"domain\": \"replies.yourdomain.com\"\n },\n \"social\": {\n \"facebookUrl\": \"https://facebook.com/groups/XXX\",\n \"googlePlus\": \"https://groups.google.com/d/XXX\",\n \"linkedIn\": \"https://www.linkedin.com/groups/XXX/profile\",\n \"foursquare\": \"https://foursquare.com/groups/XXX\",\n \"twitter\": \"https://twitter.com/XXX\",\n \"yelp\": \"https://yelp.com/XXX\",\n \"instagram\": \"https://instagram.com/XXX\",\n \"youtube\": \"https://youtube.com/XXX\",\n \"pinterest\": \"https://pinterest.com/XXX\",\n \"blogRss\": \"https://rss.xyz.com\",\n \"googlePlaceId\": \"redfdfdere\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/locations/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"i2SpAtBVHSVea1sL6oah\",\n \"name\": \"Tesla inc\",\n \"address\": \"3500 Deer Creek Road\",\n \"city\": \"Palo Alto\",\n \"country\": \"US\",\n \"state\": \"CA\",\n \"postalCode\": \"94304\",\n \"website\": \"https://www.tesla.com\",\n \"timezone\": \"US/Central\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+1202-555-0107\",\n \"business\": {\n \"name\": \"Tesla inc\",\n \"email\": \"johndeo@gmail.com\",\n \"address\": \"3500 Deer Creek Road\",\n \"city\": \"Palo Alto\",\n \"country\": \"US\",\n \"state\": \"CA\",\n \"postalCode\": \"94304\",\n \"website\": \"https://www.tesla.com\",\n \"timezone\": \"US/Central\"\n },\n \"social\": {\n \"facebookUrl\": \"https://facebook.com/groups/XXX\",\n \"googlePlus\": \"https://groups.google.com/d/XXX\",\n \"linkedIn\": \"https://www.linkedin.com/groups/XXX/profile\",\n \"foursquare\": \"https://foursquare.com/groups/XXX\",\n \"twitter\": \"https://twitter.com/XXX\",\n \"yelp\": \"https://yelp.com/XXX\",\n \"instagram\": \"https://instagram.com/XXX\",\n \"youtube\": \"https://youtube.com/XXX\",\n \"pinterest\": \"https://pinterest.com/XXX\",\n \"blogRss\": \"https://rss.xyz.com\",\n \"googlePlaceId\": \"redfdfdere\"\n },\n \"settings\": {\n \"allowDuplicateContact\": false,\n \"allowDuplicateOpportunity\": false,\n \"allowFacebookNameMerge\": false,\n \"disableContactTimezone\": false\n }\n}"},{"id":"7348d340-5ae5-41cd-af08-b4e4eb0351b7","name":"Bad Request. please contact support!","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"businessName\": \"Tesla inc\",\n \"address\": \"3500 Deer Creek Road\",\n \"city\": \"Palo Alto\",\n \"country\": \"US\",\n \"state\": \"CA\",\n \"postalCode\": \"94304\",\n \"website\": \"https://www.tesla.com\",\n \"timezone\": \"US/Central\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+1202-555-0107\",\n \"settings\": {\n \"allowDuplicateContact\": false,\n \"allowDuplicateOpportunity\": false,\n \"allowFacebookNameMerge\": false,\n \"disableContactTimezone\": false\n },\n \"twilio\": {\n \"sid\": \"AC_XXXXXXXXXXX\",\n \"authToken\": \"77_XXXXXXXXXXX\"\n },\n \"snapshot\": {\n \"id\": \"XXXXXXXXXXX\",\n \"type\": \"vertical\"\n },\n \"mailgun\": {\n \"apiKey\": \"key-XXXXXXXXXXX\",\n \"domain\": \"replies.yourdomain.com\"\n },\n \"social\": {\n \"facebookUrl\": \"https://facebook.com/groups/XXX\",\n \"googlePlus\": \"https://groups.google.com/d/XXX\",\n \"linkedIn\": \"https://www.linkedin.com/groups/XXX/profile\",\n \"foursquare\": \"https://foursquare.com/groups/XXX\",\n \"twitter\": \"https://twitter.com/XXX\",\n \"yelp\": \"https://yelp.com/XXX\",\n \"instagram\": \"https://instagram.com/XXX\",\n \"youtube\": \"https://youtube.com/XXX\",\n \"pinterest\": \"https://pinterest.com/XXX\",\n \"blogRss\": \"https://rss.xyz.com\",\n \"googlePlaceId\": \"redfdfdere\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/locations/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"011de876-b8d6-4d19-a600-112841c6b1a8","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"businessName\": \"Tesla inc\",\n \"address\": \"3500 Deer Creek Road\",\n \"city\": \"Palo Alto\",\n \"country\": \"US\",\n \"state\": \"CA\",\n \"postalCode\": \"94304\",\n \"website\": \"https://www.tesla.com\",\n \"timezone\": \"US/Central\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+1202-555-0107\",\n \"settings\": {\n \"allowDuplicateContact\": false,\n \"allowDuplicateOpportunity\": false,\n \"allowFacebookNameMerge\": false,\n \"disableContactTimezone\": false\n },\n \"twilio\": {\n \"sid\": \"AC_XXXXXXXXXXX\",\n \"authToken\": \"77_XXXXXXXXXXX\"\n },\n \"snapshot\": {\n \"id\": \"XXXXXXXXXXX\",\n \"type\": \"vertical\"\n },\n \"mailgun\": {\n \"apiKey\": \"key-XXXXXXXXXXX\",\n \"domain\": \"replies.yourdomain.com\"\n },\n \"social\": {\n \"facebookUrl\": \"https://facebook.com/groups/XXX\",\n \"googlePlus\": \"https://groups.google.com/d/XXX\",\n \"linkedIn\": \"https://www.linkedin.com/groups/XXX/profile\",\n \"foursquare\": \"https://foursquare.com/groups/XXX\",\n \"twitter\": \"https://twitter.com/XXX\",\n \"yelp\": \"https://yelp.com/XXX\",\n \"instagram\": \"https://instagram.com/XXX\",\n \"youtube\": \"https://youtube.com/XXX\",\n \"pinterest\": \"https://pinterest.com/XXX\",\n \"blogRss\": \"https://rss.xyz.com\",\n \"googlePlaceId\": \"redfdfdere\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/locations/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"50b57db2-afc8-4644-bac8-5e7ec144811b","name":"Unprocessable Entity","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"businessName\": \"Tesla inc\",\n \"address\": \"3500 Deer Creek Road\",\n \"city\": \"Palo Alto\",\n \"country\": \"US\",\n \"state\": \"CA\",\n \"postalCode\": \"94304\",\n \"website\": \"https://www.tesla.com\",\n \"timezone\": \"US/Central\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+1202-555-0107\",\n \"settings\": {\n \"allowDuplicateContact\": false,\n \"allowDuplicateOpportunity\": false,\n \"allowFacebookNameMerge\": false,\n \"disableContactTimezone\": false\n },\n \"twilio\": {\n \"sid\": \"AC_XXXXXXXXXXX\",\n \"authToken\": \"77_XXXXXXXXXXX\"\n },\n \"snapshot\": {\n \"id\": \"XXXXXXXXXXX\",\n \"type\": \"vertical\"\n },\n \"mailgun\": {\n \"apiKey\": \"key-XXXXXXXXXXX\",\n \"domain\": \"replies.yourdomain.com\"\n },\n \"social\": {\n \"facebookUrl\": \"https://facebook.com/groups/XXX\",\n \"googlePlus\": \"https://groups.google.com/d/XXX\",\n \"linkedIn\": \"https://www.linkedin.com/groups/XXX/profile\",\n \"foursquare\": \"https://foursquare.com/groups/XXX\",\n \"twitter\": \"https://twitter.com/XXX\",\n \"yelp\": \"https://yelp.com/XXX\",\n \"instagram\": \"https://instagram.com/XXX\",\n \"youtube\": \"https://youtube.com/XXX\",\n \"pinterest\": \"https://pinterest.com/XXX\",\n \"blogRss\": \"https://rss.xyz.com\",\n \"googlePlaceId\": \"redfdfdere\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/locations/"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"firstName\": {\n \"message\": \"The first name field is mandatory.\",\n \"rule\": \"required\"\n },\n \"lastName\": {\n \"message\": \"The last name field is mandatory.\",\n \"rule\": \"required\"\n },\n \"email\": {\n \"message\": \"The email field is mandatory.\",\n \"rule\": \"required\"\n },\n \"phone\": {\n \"message\": \"The email field is mandatory.\",\n \"rule\": \"required\"\n },\n \"businessName\": {\n \"message\": \"The business name field is mandatory.\",\n \"rule\": \"required\"\n },\n \"address\": {\n \"message\": \"The address field is mandatory.\",\n \"rule\": \"required\"\n },\n \"city\": {\n \"message\": \"The city field is mandatory.\",\n \"rule\": \"required\"\n },\n \"state\": {\n \"message\": \"The state field is mandatory.\",\n \"rule\": \"required\"\n },\n \"country\": {\n \"message\": \"The country field is mandatory.\",\n \"rule\": \"required\"\n },\n \"postalCode\": {\n \"message\": \"The postal code field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"2be923cc-fcbf-466a-8d8e-ff5ee1cfc244"},{"name":"/v1/locations/lookup","id":"e74596d5-360c-46cb-b3dd-e065d62c29ee","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/locations/lookup?email=john@deo.com","description":"

Find location by email.

Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys

","urlObject":{"path":["v1","locations","lookup"],"host":["https://rest.gohighlevel.com"],"query":[{"description":{"content":"

(Required) Email

\n","type":"text/plain"},"key":"email","value":"john@deo.com"}],"variable":[]}},"response":[{"id":"0eb66bd0-833b-44a6-8c57-cd5e3c9fb029","name":"Successful response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":{"raw":"https://rest.gohighlevel.com/v1/locations/lookup?email=john@deo.com","host":["https://rest.gohighlevel.com"],"path":["v1","locations","lookup"],"query":[{"key":"email","value":"john@deo.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"i2SpAtBVHSVea1sL6oah\",\n \"name\": \"Tesla inc\",\n \"address\": \"3500 Deer Creek Road\",\n \"city\": \"Palo Alto\",\n \"country\": \"US\",\n \"state\": \"CA\",\n \"postalCode\": \"94304\",\n \"website\": \"https://www.tesla.com\",\n \"timezone\": \"US/Central\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+1202-555-0107\",\n \"business\": {\n \"name\": \"Tesla inc\",\n \"email\": \"johndeo@gmail.com\",\n \"address\": \"3500 Deer Creek Road\",\n \"city\": \"Palo Alto\",\n \"country\": \"US\",\n \"state\": \"CA\",\n \"postalCode\": \"94304\",\n \"website\": \"https://www.tesla.com\",\n \"timezone\": \"US/Central\"\n },\n \"social\": {\n \"facebookUrl\": \"https://facebook.com/groups/XXX\",\n \"googlePlus\": \"https://groups.google.com/d/XXX\",\n \"linkedIn\": \"https://www.linkedin.com/groups/XXX/profile\",\n \"foursquare\": \"https://foursquare.com/groups/XXX\",\n \"twitter\": \"https://twitter.com/XXX\",\n \"yelp\": \"https://yelp.com/XXX\",\n \"instagram\": \"https://instagram.com/XXX\",\n \"youtube\": \"https://youtube.com/XXX\",\n \"pinterest\": \"https://pinterest.com/XXX\",\n \"blogRss\": \"https://rss.xyz.com\",\n \"googlePlaceId\": \"redfdfdere\"\n },\n \"settings\": {\n \"allowDuplicateContact\": false,\n \"allowDuplicateOpportunity\": false,\n \"allowFacebookNameMerge\": false,\n \"disableContactTimezone\": false\n }\n}"},{"id":"9caa4481-f018-4b0e-beb4-7fcbfcd7be22","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/locations/lookup?email=john@deo.com","host":["https://rest.gohighlevel.com"],"path":["v1","locations","lookup"],"query":[{"key":"email","value":"john@deo.com"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"60c1bb84-1cde-41ca-a14f-6d83b3dee05d","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/locations/lookup?email=john@deo.com","host":["https://rest.gohighlevel.com"],"path":["v1","locations","lookup"],"query":[{"key":"email","value":"john@deo.com"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"e74596d5-360c-46cb-b3dd-e065d62c29ee"},{"name":"/v1/locations/:locationId","id":"04869fca-21b6-4bab-b09d-f3c23d650bf4","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/locations/:locationId","description":"

Get location by location id.

Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys

","urlObject":{"path":["v1","locations",":locationId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"d5fb760b-0e8c-446b-9e24-fe31fb09241d","description":{"content":"

(Required) Location Id

\n","type":"text/plain"},"type":"any","value":"i2SpAtBVHSVea1sL6oah","key":"locationId"}]}},"response":[{"id":"c609ac36-d674-4d37-9d1f-0eca6bd88a8e","name":"Successful response","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"url":{"raw":"https://rest.gohighlevel.com/v1/locations/:locationId","host":["https://rest.gohighlevel.com"],"path":["v1","locations",":locationId"],"variable":[{"key":"locationId","value":"i2SpAtBVHSVea1sL6oah","description":"(Required) Location Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"i2SpAtBVHSVea1sL6oah\",\n \"name\": \"Tesla inc\",\n \"address\": \"3500 Deer Creek Road\",\n \"city\": \"Palo Alto\",\n \"country\": \"US\",\n \"state\": \"CA\",\n \"postalCode\": \"94304\",\n \"website\": \"https://www.tesla.com\",\n \"timezone\": \"US/Central\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+1202-555-0107\",\n \"business\": {\n \"name\": \"Tesla inc\",\n \"email\": \"johndeo@gmail.com\",\n \"address\": \"3500 Deer Creek Road\",\n \"city\": \"Palo Alto\",\n \"country\": \"US\",\n \"state\": \"CA\",\n \"postalCode\": \"94304\",\n \"website\": \"https://www.tesla.com\",\n \"timezone\": \"US/Central\"\n },\n \"social\": {\n \"facebookUrl\": \"https://facebook.com/groups/XXX\",\n \"googlePlus\": \"https://groups.google.com/d/XXX\",\n \"linkedIn\": \"https://www.linkedin.com/groups/XXX/profile\",\n \"foursquare\": \"https://foursquare.com/groups/XXX\",\n \"twitter\": \"https://twitter.com/XXX\",\n \"yelp\": \"https://yelp.com/XXX\",\n \"instagram\": \"https://instagram.com/XXX\",\n \"youtube\": \"https://youtube.com/XXX\",\n \"pinterest\": \"https://pinterest.com/XXX\",\n \"blogRss\": \"https://rss.xyz.com\",\n \"googlePlaceId\": \"redfdfdere\"\n },\n \"settings\": {\n \"allowDuplicateContact\": false,\n \"allowDuplicateOpportunity\": false,\n \"allowFacebookNameMerge\": false,\n \"disableContactTimezone\": false\n }\n}"},{"id":"18d3f6d7-ab12-4f58-be81-1fda1132390f","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/locations/:locationId","host":["https://rest.gohighlevel.com"],"path":["v1","locations",":locationId"],"variable":[{"key":"locationId","value":"i2SpAtBVHSVea1sL6oah","description":"(Required) Location Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"b5793f8d-2d9d-45cd-95f0-1abf8e4e09cc","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/locations/:locationId","host":["https://rest.gohighlevel.com"],"path":["v1","locations",":locationId"],"variable":[{"key":"locationId","value":"i2SpAtBVHSVea1sL6oah","description":"(Required) Location Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"04869fca-21b6-4bab-b09d-f3c23d650bf4"},{"name":"/v1/locations/:locationId","id":"4554e49d-0fc6-49d0-aa5c-feda76e522f0","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"businessName\": \"Tesla inc\",\n \"address\": \"3500 Deer Creek Road\",\n \"city\": \"Palo Alto\",\n \"country\": \"US\",\n \"state\": \"CA\",\n \"postalCode\": \"94304\",\n \"website\": \"https://www.tesla.com\",\n \"timezone\": \"US/Central\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+1202-555-0107\",\n \"settings\": {\n \"allowDuplicateContact\": false,\n \"allowDuplicateOpportunity\": false,\n \"allowFacebookNameMerge\": false,\n \"disableContactTimezone\": false\n },\n \"twilio\": {\n \"sid\": \"AC_XXXXXXXXXXX\",\n \"authToken\": \"77_XXXXXXXXXXX\"\n },\n \"snapshot\": {\n \"id\": \"XXXXXXXXXXX\",\n \"type\": \"vertical\"\n },\n \"mailgun\": {\n \"apiKey\": \"key-XXXXXXXXXXX\",\n \"domain\": \"replies.yourdomain.com\"\n },\n \"social\": {\n \"facebookUrl\": \"https://facebook.com/groups/XXX\",\n \"googlePlus\": \"https://groups.google.com/d/XXX\",\n \"linkedIn\": \"https://www.linkedin.com/groups/XXX/profile\",\n \"foursquare\": \"https://foursquare.com/groups/XXX\",\n \"twitter\": \"https://twitter.com/XXX\",\n \"yelp\": \"https://yelp.com/XXX\",\n \"instagram\": \"https://instagram.com/XXX\",\n \"youtube\": \"https://youtube.com/XXX\",\n \"pinterest\": \"https://pinterest.com/XXX\",\n \"blogRss\": \"https://rss.xyz.com\",\n \"googlePlaceId\": \"redfdfdere\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/locations/:locationId","description":"

Update a Location.

Required JSON fields in the body

FieldsTypesExample
businessNamestringACME Agency

Allowed JSON fields in the body

FieldsTypesExample
addressstring3500 Deer Creek Road
citystringPalo Alto
statestringCA
countrystringUS
postalCodestring94304
websitestringhttps://www.tesla.com
timezonestringUS/Central
firstNamestringJohn
lastNamestringDeno
emailstringjohndeo@gmail.com
phonestring+1202-555-0107
settingsobject{ \"allowDuplicateContact\": false, \"allowDuplicateOpportunity\": false, \"allowFacebookNameMerge\": false, \"disableContactTimezone\": false }
twilioobject{ \"sid\": \"AC_XXXXXXXXXXX\", \"authToken\": \"77_XXXXXXXXXXX\" }
mailgunobject{\"mailgun\": {\"apiKey\": \"key-XXXXXXXXXXX\", \"domain\": \"replies.yourdomain.com\"}

Twilio field required two field to setup

FieldsTypesExample
sidstringAC_XXXXXXXXXXX (Twilio Account SID)
authTokenstring77_XXXXXXXXXXX (Twilio Auth Token)

Mailgun field required two field to setup

FieldsTypesExample
apiKeystringkey-XXXXXXXXXXX
domainstringreplies.yourdomain.com

Timezone field allowed options, Can grab it from the timezone list api.


Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys

","urlObject":{"path":["v1","locations",":locationId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"15e15990-4b50-4675-bf83-648ebce281e3","description":{"content":"

(Required) Location Id

\n","type":"text/plain"},"type":"any","value":"i2SpAtBVHSVea1sL6oah","key":"locationId"}]}},"response":[{"id":"a8f7dfba-fc18-4f2b-8083-b0063481dbed","name":"Successful response","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","description":"Added as a part of security scheme: bearer"}],"body":{"mode":"raw","raw":"{\n \"businessName\": \"Tesla inc\",\n \"address\": \"3500 Deer Creek Road\",\n \"city\": \"Palo Alto\",\n \"country\": \"US\",\n \"state\": \"CA\",\n \"postalCode\": \"94304\",\n \"website\": \"https://www.tesla.com\",\n \"timezone\": \"US/Central\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+1202-555-0107\",\n \"settings\": {\n \"allowDuplicateContact\": false,\n \"allowDuplicateOpportunity\": false,\n \"allowFacebookNameMerge\": false,\n \"disableContactTimezone\": false\n },\n \"twilio\": {\n \"sid\": \"AC_XXXXXXXXXXX\",\n \"authToken\": \"77_XXXXXXXXXXX\"\n },\n \"snapshot\": {\n \"id\": \"XXXXXXXXXXX\",\n \"type\": \"vertical\"\n },\n \"mailgun\": {\n \"apiKey\": \"key-XXXXXXXXXXX\",\n \"domain\": \"replies.yourdomain.com\"\n },\n \"social\": {\n \"facebookUrl\": \"https://facebook.com/groups/XXX\",\n \"googlePlus\": \"https://groups.google.com/d/XXX\",\n \"linkedIn\": \"https://www.linkedin.com/groups/XXX/profile\",\n \"foursquare\": \"https://foursquare.com/groups/XXX\",\n \"twitter\": \"https://twitter.com/XXX\",\n \"yelp\": \"https://yelp.com/XXX\",\n \"instagram\": \"https://instagram.com/XXX\",\n \"youtube\": \"https://youtube.com/XXX\",\n \"pinterest\": \"https://pinterest.com/XXX\",\n \"blogRss\": \"https://rss.xyz.com\",\n \"googlePlaceId\": \"redfdfdere\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/locations/:locationId","host":["https://rest.gohighlevel.com"],"path":["v1","locations",":locationId"],"variable":[{"key":"locationId","value":"i2SpAtBVHSVea1sL6oah","description":"(Required) Location Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"i2SpAtBVHSVea1sL6oah\",\n \"name\": \"Tesla inc\",\n \"address\": \"3500 Deer Creek Road\",\n \"city\": \"Palo Alto\",\n \"country\": \"US\",\n \"state\": \"CA\",\n \"postalCode\": \"94304\",\n \"website\": \"https://www.tesla.com\",\n \"timezone\": \"US/Central\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+1202-555-0107\",\n \"business\": {\n \"name\": \"Tesla inc\",\n \"email\": \"johndeo@gmail.com\",\n \"address\": \"3500 Deer Creek Road\",\n \"city\": \"Palo Alto\",\n \"country\": \"US\",\n \"state\": \"CA\",\n \"postalCode\": \"94304\",\n \"website\": \"https://www.tesla.com\",\n \"timezone\": \"US/Central\"\n },\n \"social\": {\n \"facebookUrl\": \"https://facebook.com/groups/XXX\",\n \"googlePlus\": \"https://groups.google.com/d/XXX\",\n \"linkedIn\": \"https://www.linkedin.com/groups/XXX/profile\",\n \"foursquare\": \"https://foursquare.com/groups/XXX\",\n \"twitter\": \"https://twitter.com/XXX\",\n \"yelp\": \"https://yelp.com/XXX\",\n \"instagram\": \"https://instagram.com/XXX\",\n \"youtube\": \"https://youtube.com/XXX\",\n \"pinterest\": \"https://pinterest.com/XXX\",\n \"blogRss\": \"https://rss.xyz.com\",\n \"googlePlaceId\": \"redfdfdere\"\n },\n \"settings\": {\n \"allowDuplicateContact\": false,\n \"allowDuplicateOpportunity\": false,\n \"allowFacebookNameMerge\": false,\n \"disableContactTimezone\": false\n }\n}"},{"id":"8d746f23-f906-49e0-8964-081d3e65a0c0","name":"Bad Request. please contact support!","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"businessName\": \"Tesla inc\",\n \"address\": \"3500 Deer Creek Road\",\n \"city\": \"Palo Alto\",\n \"country\": \"US\",\n \"state\": \"CA\",\n \"postalCode\": \"94304\",\n \"website\": \"https://www.tesla.com\",\n \"timezone\": \"US/Central\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+1202-555-0107\",\n \"settings\": {\n \"allowDuplicateContact\": false,\n \"allowDuplicateOpportunity\": false,\n \"allowFacebookNameMerge\": false,\n \"disableContactTimezone\": false\n },\n \"twilio\": {\n \"sid\": \"AC_XXXXXXXXXXX\",\n \"authToken\": \"77_XXXXXXXXXXX\"\n },\n \"snapshot\": {\n \"id\": \"XXXXXXXXXXX\",\n \"type\": \"vertical\"\n },\n \"mailgun\": {\n \"apiKey\": \"key-XXXXXXXXXXX\",\n \"domain\": \"replies.yourdomain.com\"\n },\n \"social\": {\n \"facebookUrl\": \"https://facebook.com/groups/XXX\",\n \"googlePlus\": \"https://groups.google.com/d/XXX\",\n \"linkedIn\": \"https://www.linkedin.com/groups/XXX/profile\",\n \"foursquare\": \"https://foursquare.com/groups/XXX\",\n \"twitter\": \"https://twitter.com/XXX\",\n \"yelp\": \"https://yelp.com/XXX\",\n \"instagram\": \"https://instagram.com/XXX\",\n \"youtube\": \"https://youtube.com/XXX\",\n \"pinterest\": \"https://pinterest.com/XXX\",\n \"blogRss\": \"https://rss.xyz.com\",\n \"googlePlaceId\": \"redfdfdere\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/locations/:locationId","host":["https://rest.gohighlevel.com"],"path":["v1","locations",":locationId"],"variable":[{"key":"locationId","value":"i2SpAtBVHSVea1sL6oah","description":"(Required) Location Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"fc234b71-16c2-4ea0-a5c3-ee707a357326","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"businessName\": \"Tesla inc\",\n \"address\": \"3500 Deer Creek Road\",\n \"city\": \"Palo Alto\",\n \"country\": \"US\",\n \"state\": \"CA\",\n \"postalCode\": \"94304\",\n \"website\": \"https://www.tesla.com\",\n \"timezone\": \"US/Central\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+1202-555-0107\",\n \"settings\": {\n \"allowDuplicateContact\": false,\n \"allowDuplicateOpportunity\": false,\n \"allowFacebookNameMerge\": false,\n \"disableContactTimezone\": false\n },\n \"twilio\": {\n \"sid\": \"AC_XXXXXXXXXXX\",\n \"authToken\": \"77_XXXXXXXXXXX\"\n },\n \"snapshot\": {\n \"id\": \"XXXXXXXXXXX\",\n \"type\": \"vertical\"\n },\n \"mailgun\": {\n \"apiKey\": \"key-XXXXXXXXXXX\",\n \"domain\": \"replies.yourdomain.com\"\n },\n \"social\": {\n \"facebookUrl\": \"https://facebook.com/groups/XXX\",\n \"googlePlus\": \"https://groups.google.com/d/XXX\",\n \"linkedIn\": \"https://www.linkedin.com/groups/XXX/profile\",\n \"foursquare\": \"https://foursquare.com/groups/XXX\",\n \"twitter\": \"https://twitter.com/XXX\",\n \"yelp\": \"https://yelp.com/XXX\",\n \"instagram\": \"https://instagram.com/XXX\",\n \"youtube\": \"https://youtube.com/XXX\",\n \"pinterest\": \"https://pinterest.com/XXX\",\n \"blogRss\": \"https://rss.xyz.com\",\n \"googlePlaceId\": \"redfdfdere\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/locations/:locationId","host":["https://rest.gohighlevel.com"],"path":["v1","locations",":locationId"],"variable":[{"key":"locationId","value":"i2SpAtBVHSVea1sL6oah","description":"(Required) Location Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"e2887ab0-aaa4-44ed-a04f-1ed840ad2a5d","name":"Unprocessable Entity","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"businessName\": \"Tesla inc\",\n \"address\": \"3500 Deer Creek Road\",\n \"city\": \"Palo Alto\",\n \"country\": \"US\",\n \"state\": \"CA\",\n \"postalCode\": \"94304\",\n \"website\": \"https://www.tesla.com\",\n \"timezone\": \"US/Central\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+1202-555-0107\",\n \"settings\": {\n \"allowDuplicateContact\": false,\n \"allowDuplicateOpportunity\": false,\n \"allowFacebookNameMerge\": false,\n \"disableContactTimezone\": false\n },\n \"twilio\": {\n \"sid\": \"AC_XXXXXXXXXXX\",\n \"authToken\": \"77_XXXXXXXXXXX\"\n },\n \"snapshot\": {\n \"id\": \"XXXXXXXXXXX\",\n \"type\": \"vertical\"\n },\n \"mailgun\": {\n \"apiKey\": \"key-XXXXXXXXXXX\",\n \"domain\": \"replies.yourdomain.com\"\n },\n \"social\": {\n \"facebookUrl\": \"https://facebook.com/groups/XXX\",\n \"googlePlus\": \"https://groups.google.com/d/XXX\",\n \"linkedIn\": \"https://www.linkedin.com/groups/XXX/profile\",\n \"foursquare\": \"https://foursquare.com/groups/XXX\",\n \"twitter\": \"https://twitter.com/XXX\",\n \"yelp\": \"https://yelp.com/XXX\",\n \"instagram\": \"https://instagram.com/XXX\",\n \"youtube\": \"https://youtube.com/XXX\",\n \"pinterest\": \"https://pinterest.com/XXX\",\n \"blogRss\": \"https://rss.xyz.com\",\n \"googlePlaceId\": \"redfdfdere\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/locations/:locationId","host":["https://rest.gohighlevel.com"],"path":["v1","locations",":locationId"],"variable":[{"key":"locationId","value":"i2SpAtBVHSVea1sL6oah","description":"(Required) Location Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"firstName\": {\n \"message\": \"The first name field is mandatory.\",\n \"rule\": \"required\"\n },\n \"lastName\": {\n \"message\": \"The last name field is mandatory.\",\n \"rule\": \"required\"\n },\n \"email\": {\n \"message\": \"The email field is mandatory.\",\n \"rule\": \"required\"\n },\n \"phone\": {\n \"message\": \"The email field is mandatory.\",\n \"rule\": \"required\"\n },\n \"businessName\": {\n \"message\": \"The business name field is mandatory.\",\n \"rule\": \"required\"\n },\n \"address\": {\n \"message\": \"The address field is mandatory.\",\n \"rule\": \"required\"\n },\n \"city\": {\n \"message\": \"The city field is mandatory.\",\n \"rule\": \"required\"\n },\n \"state\": {\n \"message\": \"The state field is mandatory.\",\n \"rule\": \"required\"\n },\n \"country\": {\n \"message\": \"The country field is mandatory.\",\n \"rule\": \"required\"\n },\n \"postalCode\": {\n \"message\": \"The postal code field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"4554e49d-0fc6-49d0-aa5c-feda76e522f0"},{"name":"/v1/locations/:locationId","id":"a59b4ce5-0657-46c7-8351-cb42e166e276","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"DELETE","header":[],"url":"https://rest.gohighlevel.com/v1/locations/:locationId?deleteTwilioAccount=false","description":"

Delete location.

Allowed fields in the query parameter.

FieldsAllowed OptionsDefault valueDescription
deleteTwilioAccounttrue or falsefalseIf you pass true, When deleting the subaccount. We delete Twilio subaccount (on Twilio side) as well.
Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys

","urlObject":{"path":["v1","locations",":locationId"],"host":["https://rest.gohighlevel.com"],"query":[{"description":{"content":"

Delete Twilio Account

\n","type":"text/plain"},"key":"deleteTwilioAccount","value":"false"}],"variable":[{"id":"a5bb51dc-c2c2-4e25-b8a1-72eb21d338b8","description":{"content":"

(Required) Location Id

\n","type":"text/plain"},"type":"any","value":"i2SpAtBVHSVea1sL6oah","key":"locationId"}]}},"response":[{"id":"f920201e-76ab-4ac2-9fac-30f7362406fe","name":"Successful response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/locations/:locationId?deleteTwilioAccount=false","host":["https://rest.gohighlevel.com"],"path":["v1","locations",":locationId"],"query":[{"key":"deleteTwilioAccount","value":"false"}],"variable":[{"key":"locationId","value":"i2SpAtBVHSVea1sL6oah","description":"(Required) Location Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Success\"\n}"},{"id":"2aa6ba68-4b4b-488c-80be-94d2e65d2738","name":"Bad Request. please contact support!","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/locations/:locationId?deleteTwilioAccount=false","host":["https://rest.gohighlevel.com"],"path":["v1","locations",":locationId"],"query":[{"key":"deleteTwilioAccount","value":"false"}],"variable":[{"key":"locationId","value":"i2SpAtBVHSVea1sL6oah","description":"(Required) Location Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"4fce2c0a-79f5-4c72-a42e-7742922456ac","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/locations/:locationId?deleteTwilioAccount=false","host":["https://rest.gohighlevel.com"],"path":["v1","locations",":locationId"],"query":[{"key":"deleteTwilioAccount","value":"false"}],"variable":[{"key":"locationId","value":"i2SpAtBVHSVea1sL6oah","description":"(Required) Location Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"0522d7be-2041-43a9-bd48-a306e350289b","name":"Unprocessable Entity","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/locations/:locationId?deleteTwilioAccount=false","host":["https://rest.gohighlevel.com"],"path":["v1","locations",":locationId"],"query":[{"key":"deleteTwilioAccount","value":"false"}],"variable":[{"key":"locationId","value":"i2SpAtBVHSVea1sL6oah","description":"(Required) Location Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"locationId\": {\n \"message\": \"The location id is invalid.\",\n \"rule\": \"invalid\"\n }\n}"}],"_postman_id":"a59b4ce5-0657-46c7-8351-cb42e166e276"},{"name":"/v1/locations/:locationId/load-snapshot/:snapshotId","id":"3b8033f9-5398-496b-92ee-01d56d4d1944","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"override\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/locations/:locationId/load-snapshot/:snapshotId","description":"

Load Snapshot.

Fields
  1. override*: We will allow true or false. If you want override all conflict assets then pass true. By default it false. By default it false
Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys

","urlObject":{"path":["v1","locations",":locationId","load-snapshot",":snapshotId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"e8a067af-4d12-48a9-976b-e6bc109cd2bb","description":{"content":"

(Required) Location Id

\n","type":"text/plain"},"type":"any","value":"i2SpAtBVHSVea1sL6oah","key":"locationId"},{"id":"ee72180c-55f6-4332-9d4d-2ca94d2e99ad","description":{"content":"

(Required) Snapshot Id

\n","type":"text/plain"},"type":"any","value":"5bFKHqudfotv3c1xFUuP","key":"snapshotId"}]}},"response":[{"id":"8e047f19-e2fa-4d52-aa77-a294ee5efcba","name":"Successful response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"override\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/locations/:locationId/load-snapshot/:snapshotId","host":["https://rest.gohighlevel.com"],"path":["v1","locations",":locationId","load-snapshot",":snapshotId"],"variable":[{"key":"locationId","value":"i2SpAtBVHSVea1sL6oah","description":"(Required) Location Id"},{"key":"snapshotId","value":"5bFKHqudfotv3c1xFUuP","description":"(Required) Snapshot Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Copying the data, we will send a notification once it's completed.\"\n}"},{"id":"b7ce155a-e721-4b8d-8d9f-88b8992d1fe9","name":"Bad Request. please contact support!","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"override\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/locations/:locationId/load-snapshot/:snapshotId","host":["https://rest.gohighlevel.com"],"path":["v1","locations",":locationId","load-snapshot",":snapshotId"],"variable":[{"key":"locationId","value":"i2SpAtBVHSVea1sL6oah","description":"(Required) Location Id"},{"key":"snapshotId","value":"5bFKHqudfotv3c1xFUuP","description":"(Required) Snapshot Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"ca2c6f67-a6bc-4cd2-98a0-12d24ef66b64","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"override\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/locations/:locationId/load-snapshot/:snapshotId","host":["https://rest.gohighlevel.com"],"path":["v1","locations",":locationId","load-snapshot",":snapshotId"],"variable":[{"key":"locationId","value":"i2SpAtBVHSVea1sL6oah","description":"(Required) Location Id"},{"key":"snapshotId","value":"5bFKHqudfotv3c1xFUuP","description":"(Required) Snapshot Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"04f42577-94b7-42ba-b7f6-81d9f729dbe0","name":"Unprocessable Entity","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"override\": false\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/locations/:locationId/load-snapshot/:snapshotId","host":["https://rest.gohighlevel.com"],"path":["v1","locations",":locationId","load-snapshot",":snapshotId"],"variable":[{"key":"locationId","value":"i2SpAtBVHSVea1sL6oah","description":"(Required) Location Id"},{"key":"snapshotId","value":"5bFKHqudfotv3c1xFUuP","description":"(Required) Snapshot Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"locationId\": {\n \"message\": \"The location id is invalid.\",\n \"rule\": \"invalid\"\n },\n \"snapshotId\": {\n \"message\": \"The snapshot id is invalid.\",\n \"rule\": \"invalid\"\n }\n}"}],"_postman_id":"3b8033f9-5398-496b-92ee-01d56d4d1944"}],"id":"bb3cfa1e-2c2b-4fcf-8c74-c10f215a7462","_postman_id":"bb3cfa1e-2c2b-4fcf-8c74-c10f215a7462","description":"","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","name":"GoHighLevel API V1.1.20","type":"collection"}}},{"name":"Note","item":[{"name":"/v1/contacts/:contactId/notes/","id":"d959ab91-6882-4889-b507-7d40f4bf85a2","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/contacts/:contactId/notes/","description":"

Get all contact notes.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","contacts",":contactId","notes",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"f4a3d386-c0df-47fa-9b4b-544798e02d68","description":{"content":"

(Required) Contact Id

\n","type":"text/plain"},"type":"any","value":"sx6wyHhbFdRXh302LLNR","key":"contactId"}]}},"response":[{"id":"a5476656-457a-497b-83a4-a11c156cd5ce","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/notes/","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","notes",""],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"notes\": [\n {\n \"id\": \"Lj371SHlVMyfVlMcKiuk\",\n \"body\": \"Loram ipsum\",\n \"createdBy\": \"Loram ipsum\",\n \"createdAt\": \"2020-10-20T12:52:17.561Z\"\n },\n {\n \"id\": \"Lj371SHlVMyfVlMcKiuk\",\n \"body\": \"Loram ipsum\",\n \"createdBy\": \"Loram ipsum\",\n \"createdAt\": \"2020-10-20T12:52:17.561Z\"\n }\n ]\n}"},{"id":"3a9b93f5-694c-4bdf-bc68-5230cdfa71ca","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/notes/","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","notes",""],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"408d890b-5565-41c6-ab3d-b254ab98d587","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/notes/","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","notes",""],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"d959ab91-6882-4889-b507-7d40f4bf85a2"},{"name":"/v1/contacts/:contactId/notes/","id":"f42375be-7aaf-4a6e-9b30-3a572341e987","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"body\": \"lorem ipsum\",\n \"userId\": \"GCs5KuzPqTls7vWclkEV\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/contacts/:contactId/notes/","description":"

Create Notes.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","contacts",":contactId","notes",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"1f3cee89-2ec8-4f60-9054-7c1498d245b9","description":{"content":"

(Required) Contact Id

\n","type":"text/plain"},"type":"any","value":"sx6wyHhbFdRXh302LLNR","key":"contactId"}]}},"response":[{"id":"bd368a7d-4af8-43cc-bdb7-648bc674c2e1","name":"Successful response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"body\": \"lorem ipsum\",\n \"userId\": \"GCs5KuzPqTls7vWclkEV\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/notes/","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","notes",""],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"Lj371SHlVMyfVlMcKiuk\",\n \"body\": \"Loram ipsum\",\n \"createdBy\": \"Loram ipsum\",\n \"createdAt\": \"2020-10-20T12:52:17.561Z\"\n}"},{"id":"c70b8fc3-1698-4c7e-84a6-f935165d4461","name":"Bad Request. please contact support!","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"body\": \"lorem ipsum\",\n \"userId\": \"GCs5KuzPqTls7vWclkEV\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/notes/","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","notes",""],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"ac3aa0b2-4645-42db-bd91-8d72c91df37a","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"body\": \"lorem ipsum\",\n \"userId\": \"GCs5KuzPqTls7vWclkEV\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/notes/","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","notes",""],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"5ac0e68d-6dce-4edf-b92e-242831a893ed","name":"Unprocessable Entity","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"body\": \"lorem ipsum\",\n \"userId\": \"GCs5KuzPqTls7vWclkEV\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/notes/","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","notes",""],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"body\": {\n \"message\": \"The body field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"f42375be-7aaf-4a6e-9b30-3a572341e987"},{"name":"/v1/contacts/:contactId/notes/:noteId","id":"f62b6d14-1d62-45cb-a41e-6d059203ff34","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/contacts/:contactId/notes/:noteId","description":"

Get note by id.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","contacts",":contactId","notes",":noteId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"75dc7b33-4c42-4688-95a0-21f863cd93c4","description":{"content":"

(Required) Contact Id

\n","type":"text/plain"},"type":"any","value":"sx6wyHhbFdRXh302LLNR","key":"contactId"},{"id":"6d018ab1-b7ef-4b84-a578-fe97cd74ed43","description":{"content":"

(Required) Note Id

\n","type":"text/plain"},"type":"any","value":"ocQHyuzHvysMo5N5VsXc","key":"noteId"}]}},"response":[{"id":"7e484e68-4287-4e4e-b8bc-1543e8788198","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/notes/:noteId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","notes",":noteId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"noteId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Note Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"Lj371SHlVMyfVlMcKiuk\",\n \"body\": \"Loram ipsum\",\n \"createdBy\": \"Loram ipsum\",\n \"createdAt\": \"2020-10-20T12:52:17.561Z\"\n}"},{"id":"3274ae1b-5753-4bae-8e5a-02e1976dc5a1","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/notes/:noteId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","notes",":noteId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"noteId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Note Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"286ca67d-ac88-48c5-b368-2c8300273020","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/notes/:noteId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","notes",":noteId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"noteId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Note Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"f62b6d14-1d62-45cb-a41e-6d059203ff34"},{"name":"/v1/contacts/:contactId/notes/:noteId","id":"68a40c0b-9ec7-467d-b06c-b17dbdedf1d0","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"body\": \"lorem ipsum\",\n \"userId\": \"GCs5KuzPqTls7vWclkEV\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/contacts/:contactId/notes/:noteId","description":"

Update Note.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","contacts",":contactId","notes",":noteId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"0e72cdf6-03b1-473b-a353-efe17f3934ea","description":{"content":"

(Required) Contact Id

\n","type":"text/plain"},"type":"any","value":"sx6wyHhbFdRXh302LLNR","key":"contactId"},{"id":"ab042230-a11b-4b09-9c53-4ad54f628aff","description":{"content":"

(Required) Note Id

\n","type":"text/plain"},"type":"any","value":"ocQHyuzHvysMo5N5VsXc","key":"noteId"}]}},"response":[{"id":"04327b03-8f01-4798-818b-e307ebce66ee","name":"Successful response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"body\": \"lorem ipsum\",\n \"userId\": \"GCs5KuzPqTls7vWclkEV\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/notes/:noteId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","notes",":noteId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"noteId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Note Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"Lj371SHlVMyfVlMcKiuk\",\n \"body\": \"Loram ipsum\",\n \"createdBy\": \"Loram ipsum\",\n \"createdAt\": \"2020-10-20T12:52:17.561Z\"\n}"},{"id":"1163bdaf-7d35-4832-9c00-4993c83623dd","name":"Bad Request. please contact support!","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"body\": \"lorem ipsum\",\n \"userId\": \"GCs5KuzPqTls7vWclkEV\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/notes/:noteId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","notes",":noteId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"noteId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Note Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"f4bc815f-a226-4e6e-9c2b-a14689de807c","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"body\": \"lorem ipsum\",\n \"userId\": \"GCs5KuzPqTls7vWclkEV\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/notes/:noteId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","notes",":noteId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"noteId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Note Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"8e1edd84-7810-410c-a419-c48cd0bf0e5d","name":"Unprocessable Entity","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"body\": \"lorem ipsum\",\n \"userId\": \"GCs5KuzPqTls7vWclkEV\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/notes/:noteId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","notes",":noteId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"noteId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Note Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"body\": {\n \"message\": \"The body field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"68a40c0b-9ec7-467d-b06c-b17dbdedf1d0"},{"name":"/v1/contacts/:contactId/notes/:noteId","id":"a4468fed-d67e-48bb-b0e2-5a8146c75453","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"DELETE","header":[],"url":"https://rest.gohighlevel.com/v1/contacts/:contactId/notes/:noteId","description":"

Delete one of Notes.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","contacts",":contactId","notes",":noteId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"02e9f345-6790-4ba4-8386-1c2d5a4b4c44","description":{"content":"

(Required) Contact Id

\n","type":"text/plain"},"type":"any","value":"sx6wyHhbFdRXh302LLNR","key":"contactId"},{"id":"13a5d629-2229-40c7-b559-ee62d14f548b","description":{"content":"

(Required) Note Id

\n","type":"text/plain"},"type":"any","value":"ocQHyuzHvysMo5N5VsXc","key":"noteId"}]}},"response":[{"id":"35e70295-a014-429e-a46c-a449915c0241","name":"Successful response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/notes/:noteId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","notes",":noteId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"noteId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Note Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"\"\""},{"id":"dff8312f-34a0-4d32-bae2-26ec56cd8dc1","name":"Bad Request. please contact support!","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/notes/:noteId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","notes",":noteId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"noteId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Note Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"9e4eead4-581a-46d7-96c4-ecd357969d59","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/notes/:noteId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","notes",":noteId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"noteId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Note Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"a4468fed-d67e-48bb-b0e2-5a8146c75453"}],"id":"92e38c64-8309-4b7a-9532-c873e5e37f84","_postman_id":"92e38c64-8309-4b7a-9532-c873e5e37f84","description":"","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","name":"GoHighLevel API V1.1.20","type":"collection"}}},{"name":"Opportunity","item":[{"name":"/v1/pipelines/:pipelineId/opportunities","id":"caf00210-5b8c-432b-a432-ca461bb85423","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/pipelines/:pipelineId/opportunities?startAfterId=UIaE1WjAwWKdlyD7osQI&startAfter=1603870249758&limit=20","description":"

Get opportunities.

Allowed filter in the query

Fields Types Example Allowed Options
stageIdstring7915dedc-8f18-44d5-8bc3-77c04e994a10
monetaryValuenumber220
assignedTostring082goXVW3lIExEQPOnd3
campaignIdstringY2I9XM7aO1hncuSOlc9L
startDatenumberepoch timestamp. for ex: 1598107050459
endDatenumberepoch timestamp. for ex: 1614091050459
querystring?query=john@deo.com
statusstringopen
  • open
  • won
  • lost
  • abandoned

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","pipelines",":pipelineId","opportunities"],"host":["https://rest.gohighlevel.com"],"query":[{"description":{"content":"

Start After Id

\n","type":"text/plain"},"key":"startAfterId","value":"UIaE1WjAwWKdlyD7osQI"},{"description":{"content":"

Start After

\n","type":"text/plain"},"key":"startAfter","value":"1603870249758"},{"description":{"content":"

Limit Per Page records count. will allow maximum up to 100 and default will be 20

\n","type":"text/plain"},"key":"limit","value":"20"}],"variable":[{"id":"d1f17d10-00fa-4fac-a779-87915163f6ec","description":{"content":"

(Required) Pipeline Id

\n","type":"text/plain"},"type":"any","value":"bCkKGpDsyPP4peuKowkG","key":"pipelineId"}]}},"response":[{"id":"c4751e56-efe5-4366-929f-86c930e4b5fc","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/pipelines/:pipelineId/opportunities?startAfterId=UIaE1WjAwWKdlyD7osQI&startAfter=1603870249758&limit=20","host":["https://rest.gohighlevel.com"],"path":["v1","pipelines",":pipelineId","opportunities"],"query":[{"key":"startAfterId","value":"UIaE1WjAwWKdlyD7osQI"},{"key":"startAfter","value":"1603870249758"},{"key":"limit","value":"20"}],"variable":[{"key":"pipelineId","value":"bCkKGpDsyPP4peuKowkG","description":"(Required) Pipeline Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"opportunities\": [\n {\n \"id\": \"7XExm1wr8gFeZpl6rQny\",\n \"name\": \"First Opp\",\n \"monetaryValue\": 120,\n \"pipelineId\": \"bCkKGpDsyPP4peuKowkG\",\n \"pipelineStageId\": \"8b897c8f-b859-49c1-88f2-ed590708a85c\",\n \"assignedTo\": \"hxHGVRb1YJUscrCB8eXK\",\n \"status\": \"open\",\n \"source\": \"form\",\n \"lastStatusChangeAt\": \"2020-10-29T09:39:35.472Z\",\n \"createdAt\": \"2020-10-29T09:31:30.255Z\",\n \"updatedAt\": \"2020-10-29T09:44:02.263Z\",\n \"contact\": {\n \"id\": \"byMEV0NQinDhq8ZfiOi2\",\n \"name\": \"John Deo\",\n \"companyName\": \"Tesla Inc\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+1202-555-0107\",\n \"tags\": [\n \"ipsum sunt\",\n \"ipsum mollit deserunt id veniam\"\n ]\n }\n },\n {\n \"id\": \"7XExm1wr8gFeZpl6rQny\",\n \"name\": \"First Opp\",\n \"monetaryValue\": 120,\n \"pipelineId\": \"bCkKGpDsyPP4peuKowkG\",\n \"pipelineStageId\": \"8b897c8f-b859-49c1-88f2-ed590708a85c\",\n \"assignedTo\": \"hxHGVRb1YJUscrCB8eXK\",\n \"status\": \"open\",\n \"source\": \"form\",\n \"lastStatusChangeAt\": \"2020-10-29T09:39:35.472Z\",\n \"createdAt\": \"2020-10-29T09:31:30.255Z\",\n \"updatedAt\": \"2020-10-29T09:44:02.263Z\",\n \"contact\": {\n \"id\": \"byMEV0NQinDhq8ZfiOi2\",\n \"name\": \"John Deo\",\n \"companyName\": \"Tesla Inc\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+1202-555-0107\",\n \"tags\": [\n \"laborum officia consequat consectetur\",\n \"amet ea pariatur cupidatat\"\n ]\n }\n }\n ],\n \"meta\": {\n \"total\": 250,\n \"nextPageUrl\": \"https://rest.gohighlevel.com/v1/pipelines/bCkKGpDsyPP4peuKowkG/opportunities?limit=1&startAfter=1603870249758&startAfterId=UIaE1WjAwWKdlyD7osQI\",\n \"startAfterId\": \"UIaE1WjAwWKdlyD7osQI\",\n \"startAfter\": 1603870249758,\n \"currentPage\": 2,\n \"nextPage\": 3,\n \"prevPage\": 1\n }\n}"},{"id":"1952dd87-43fd-49ea-bf9c-442e0203e20f","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/pipelines/:pipelineId/opportunities?startAfterId=UIaE1WjAwWKdlyD7osQI&startAfter=1603870249758&limit=20","host":["https://rest.gohighlevel.com"],"path":["v1","pipelines",":pipelineId","opportunities"],"query":[{"key":"startAfterId","value":"UIaE1WjAwWKdlyD7osQI"},{"key":"startAfter","value":"1603870249758"},{"key":"limit","value":"20"}],"variable":[{"key":"pipelineId","value":"bCkKGpDsyPP4peuKowkG","description":"(Required) Pipeline Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"c6885361-0ad5-4373-9111-75eab1ab2a15","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/pipelines/:pipelineId/opportunities?startAfterId=UIaE1WjAwWKdlyD7osQI&startAfter=1603870249758&limit=20","host":["https://rest.gohighlevel.com"],"path":["v1","pipelines",":pipelineId","opportunities"],"query":[{"key":"startAfterId","value":"UIaE1WjAwWKdlyD7osQI"},{"key":"startAfter","value":"1603870249758"},{"key":"limit","value":"20"}],"variable":[{"key":"pipelineId","value":"bCkKGpDsyPP4peuKowkG","description":"(Required) Pipeline Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"caf00210-5b8c-432b-a432-ca461bb85423"},{"name":"/v1/pipelines/:pipelineId/opportunities/:opportunityId","id":"3985425b-c1e4-4456-bf23-17aa4f8e2ced","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/pipelines/:pipelineId/opportunities/:opportunityId","description":"

Get opportunity by id.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","pipelines",":pipelineId","opportunities",":opportunityId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"c495a448-3fd5-4c82-920f-2a314cdf91d6","description":{"content":"

(Required) Pipeline Id

\n","type":"text/plain"},"type":"any","value":"bCkKGpDsyPP4peuKowkG","key":"pipelineId"},{"id":"f513ccc7-a747-4908-bd27-9e907c9004e2","description":{"content":"

(Required) Opportunity Id

\n","type":"text/plain"},"type":"any","value":"123akv4LFn6C9frZoy3e","key":"opportunityId"}]}},"response":[{"id":"4105fe57-d438-44b9-897b-1b2a4c2b8e5a","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/pipelines/:pipelineId/opportunities/:opportunityId","host":["https://rest.gohighlevel.com"],"path":["v1","pipelines",":pipelineId","opportunities",":opportunityId"],"variable":[{"key":"pipelineId","value":"bCkKGpDsyPP4peuKowkG","description":"(Required) Pipeline Id"},{"key":"opportunityId","value":"123akv4LFn6C9frZoy3e","description":"(Required) Opportunity Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"7XExm1wr8gFeZpl6rQny\",\n \"name\": \"First Opp\",\n \"monetaryValue\": 120,\n \"pipelineId\": \"bCkKGpDsyPP4peuKowkG\",\n \"pipelineStageId\": \"8b897c8f-b859-49c1-88f2-ed590708a85c\",\n \"assignedTo\": \"hxHGVRb1YJUscrCB8eXK\",\n \"status\": \"open\",\n \"source\": \"form\",\n \"lastStatusChangeAt\": \"2020-10-29T09:39:35.472Z\",\n \"createdAt\": \"2020-10-29T09:31:30.255Z\",\n \"updatedAt\": \"2020-10-29T09:44:02.263Z\",\n \"contact\": {\n \"id\": \"byMEV0NQinDhq8ZfiOi2\",\n \"name\": \"John Deo\",\n \"companyName\": \"Tesla Inc\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+1202-555-0107\",\n \"tags\": [\n \"occaecat do Lorem\",\n \"magna ipsum in\"\n ]\n }\n}"},{"id":"9e7ccf02-6e4b-4c9e-98c9-d2e9b1697817","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/pipelines/:pipelineId/opportunities/:opportunityId","host":["https://rest.gohighlevel.com"],"path":["v1","pipelines",":pipelineId","opportunities",":opportunityId"],"variable":[{"key":"pipelineId","value":"bCkKGpDsyPP4peuKowkG","description":"(Required) Pipeline Id"},{"key":"opportunityId","value":"123akv4LFn6C9frZoy3e","description":"(Required) Opportunity Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"6779c082-74b1-4f28-b278-e9e344873b5c","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/pipelines/:pipelineId/opportunities/:opportunityId","host":["https://rest.gohighlevel.com"],"path":["v1","pipelines",":pipelineId","opportunities",":opportunityId"],"variable":[{"key":"pipelineId","value":"bCkKGpDsyPP4peuKowkG","description":"(Required) Pipeline Id"},{"key":"opportunityId","value":"123akv4LFn6C9frZoy3e","description":"(Required) Opportunity Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"3985425b-c1e4-4456-bf23-17aa4f8e2ced"},{"name":"/v1/pipelines/:pipelineId/opportunities/:opportunityId","id":"63b8e377-c77a-49f0-b738-ec8695250f7f","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"First Opp\",\n \"status\": \"open\",\n \"stageId\": \"7915dedc-8f18-44d5-8bc3-77c04e994a10\",\n \"email\": \"elon@musk.com\",\n \"phone\": \"+1202-555-0107\",\n \"assignedTo\": \"082goXVW3lIExEQPOnd3\",\n \"monetaryValue\": 122.22,\n \"source\": \"public api\",\n \"contactId\": \"mTkSCb1UBjb5tk4OvB69\",\n \"name\": \"Elon Musk\",\n \"companyName\": \"Tesla\",\n \"tags\": [\n \"voluptate do et sed\",\n \"voluptate dolore Ut\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/pipelines/:pipelineId/opportunities/:opportunityId","description":"

Update Opportunity.

Required JSON fields in the body

Fields Types Example Allowed Options
titlestringFirst Opps
stageIdstring7915dedc-8f18-44d5-8bc3-77c04e994a10
statusstringopen
  • open
  • won
  • lost
  • abandoned

Allowed JSON fields in the body

Fields Types Example
monetaryValuenumber220
assignedTostring082goXVW3lIExEQPOnd3
contactIdstringmTkSCb1UBjb5tk4OvB69
emailstringjohn@deo.com
namestringJohn Deo
phonestring+1202-555-0107
tagsarray[\"tag1\", \"tag2\"]
companyNamestringTesla Inc

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","pipelines",":pipelineId","opportunities",":opportunityId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"583f4487-5374-42d1-a616-f35e98b73b88","description":{"content":"

(Required) Pipeline Id

\n","type":"text/plain"},"type":"any","value":"bCkKGpDsyPP4peuKowkG","key":"pipelineId"},{"id":"6e5cb104-ea69-4aef-ae2e-65630d03f3ce","description":{"content":"

(Required) Opportunity Id

\n","type":"text/plain"},"type":"any","value":"123akv4LFn6C9frZoy3e","key":"opportunityId"}]}},"response":[{"id":"7e976f37-81b8-4d59-aff5-efdecbfc1860","name":"Successful response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"title\": \"First Opp\",\n \"status\": \"open\",\n \"stageId\": \"7915dedc-8f18-44d5-8bc3-77c04e994a10\",\n \"email\": \"elon@musk.com\",\n \"phone\": \"+1202-555-0107\",\n \"assignedTo\": \"082goXVW3lIExEQPOnd3\",\n \"monetaryValue\": 122.22,\n \"source\": \"public api\",\n \"contactId\": \"mTkSCb1UBjb5tk4OvB69\",\n \"name\": \"Elon Musk\",\n \"companyName\": \"Tesla\",\n \"tags\": [\n \"tempor ea adipisicing ut amet\",\n \"voluptate irure\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/pipelines/:pipelineId/opportunities/:opportunityId","host":["https://rest.gohighlevel.com"],"path":["v1","pipelines",":pipelineId","opportunities",":opportunityId"],"variable":[{"key":"pipelineId","value":"bCkKGpDsyPP4peuKowkG","description":"(Required) Pipeline Id"},{"key":"opportunityId","value":"123akv4LFn6C9frZoy3e","description":"(Required) Opportunity Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"7XExm1wr8gFeZpl6rQny\",\n \"name\": \"First Opp\",\n \"monetaryValue\": 120,\n \"pipelineId\": \"bCkKGpDsyPP4peuKowkG\",\n \"pipelineStageId\": \"8b897c8f-b859-49c1-88f2-ed590708a85c\",\n \"assignedTo\": \"hxHGVRb1YJUscrCB8eXK\",\n \"status\": \"open\",\n \"source\": \"form\",\n \"lastStatusChangeAt\": \"2020-10-29T09:39:35.472Z\",\n \"createdAt\": \"2020-10-29T09:31:30.255Z\",\n \"updatedAt\": \"2020-10-29T09:44:02.263Z\",\n \"contact\": {\n \"id\": \"byMEV0NQinDhq8ZfiOi2\",\n \"name\": \"John Deo\",\n \"companyName\": \"Tesla Inc\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+1202-555-0107\",\n \"tags\": [\n \"occaecat do Lorem\",\n \"magna ipsum in\"\n ]\n }\n}"},{"id":"afdc5a79-9557-4742-b676-7348a337b937","name":"Bad Request. please contact support!","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"title\": \"First Opp\",\n \"status\": \"open\",\n \"stageId\": \"7915dedc-8f18-44d5-8bc3-77c04e994a10\",\n \"email\": \"elon@musk.com\",\n \"phone\": \"+1202-555-0107\",\n \"assignedTo\": \"082goXVW3lIExEQPOnd3\",\n \"monetaryValue\": 122.22,\n \"source\": \"public api\",\n \"contactId\": \"mTkSCb1UBjb5tk4OvB69\",\n \"name\": \"Elon Musk\",\n \"companyName\": \"Tesla\",\n \"tags\": [\n \"tempor ea adipisicing ut amet\",\n \"voluptate irure\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/pipelines/:pipelineId/opportunities/:opportunityId","host":["https://rest.gohighlevel.com"],"path":["v1","pipelines",":pipelineId","opportunities",":opportunityId"],"variable":[{"key":"pipelineId","value":"bCkKGpDsyPP4peuKowkG","description":"(Required) Pipeline Id"},{"key":"opportunityId","value":"123akv4LFn6C9frZoy3e","description":"(Required) Opportunity Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"26d5d261-cf89-40f7-84ee-ebc6fac17b99","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"title\": \"First Opp\",\n \"status\": \"open\",\n \"stageId\": \"7915dedc-8f18-44d5-8bc3-77c04e994a10\",\n \"email\": \"elon@musk.com\",\n \"phone\": \"+1202-555-0107\",\n \"assignedTo\": \"082goXVW3lIExEQPOnd3\",\n \"monetaryValue\": 122.22,\n \"source\": \"public api\",\n \"contactId\": \"mTkSCb1UBjb5tk4OvB69\",\n \"name\": \"Elon Musk\",\n \"companyName\": \"Tesla\",\n \"tags\": [\n \"tempor ea adipisicing ut amet\",\n \"voluptate irure\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/pipelines/:pipelineId/opportunities/:opportunityId","host":["https://rest.gohighlevel.com"],"path":["v1","pipelines",":pipelineId","opportunities",":opportunityId"],"variable":[{"key":"pipelineId","value":"bCkKGpDsyPP4peuKowkG","description":"(Required) Pipeline Id"},{"key":"opportunityId","value":"123akv4LFn6C9frZoy3e","description":"(Required) Opportunity Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"569268fe-a67b-4243-af43-c26353790a93","name":"Unprocessable Entity","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"title\": \"First Opp\",\n \"status\": \"open\",\n \"stageId\": \"7915dedc-8f18-44d5-8bc3-77c04e994a10\",\n \"email\": \"elon@musk.com\",\n \"phone\": \"+1202-555-0107\",\n \"assignedTo\": \"082goXVW3lIExEQPOnd3\",\n \"monetaryValue\": 122.22,\n \"source\": \"public api\",\n \"contactId\": \"mTkSCb1UBjb5tk4OvB69\",\n \"name\": \"Elon Musk\",\n \"companyName\": \"Tesla\",\n \"tags\": [\n \"tempor ea adipisicing ut amet\",\n \"voluptate irure\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/pipelines/:pipelineId/opportunities/:opportunityId","host":["https://rest.gohighlevel.com"],"path":["v1","pipelines",":pipelineId","opportunities",":opportunityId"],"variable":[{"key":"pipelineId","value":"bCkKGpDsyPP4peuKowkG","description":"(Required) Pipeline Id"},{"key":"opportunityId","value":"123akv4LFn6C9frZoy3e","description":"(Required) Opportunity Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"title\": {\n \"message\": \"The title field is mandatory.\",\n \"rule\": \"required\"\n },\n \"status\": {\n \"message\": \"The status field is mandatory.\",\n \"rule\": \"required\"\n },\n \"stageId\": {\n \"message\": \"The stage id field is mandatory.\",\n \"rule\": \"required\"\n },\n \"contactId or email\": {\n \"message\": \"The contactId or email field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"63b8e377-c77a-49f0-b738-ec8695250f7f"},{"name":"/v1/pipelines/:pipelineId/opportunities/:opportunityId","id":"be7d2fbc-c9ee-4a43-a55a-f6c1fb8bf3f7","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"DELETE","header":[],"url":"https://rest.gohighlevel.com/v1/pipelines/:pipelineId/opportunities/:opportunityId","description":"

Delete opportunity.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","pipelines",":pipelineId","opportunities",":opportunityId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"b5d7f3a3-65ec-4e7b-bbd9-0f86994e1b7d","description":{"content":"

(Required) Pipeline Id

\n","type":"text/plain"},"type":"any","value":"bCkKGpDsyPP4peuKowkG","key":"pipelineId"},{"id":"7c2fa41a-d543-470d-b6a0-cdbe1cb2bf5c","description":{"content":"

(Required) Opportunity Id

\n","type":"text/plain"},"type":"any","value":"123akv4LFn6C9frZoy3e","key":"opportunityId"}]}},"response":[{"id":"112050b6-d266-4c3f-bcde-adbfb66cca0f","name":"Successful response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/pipelines/:pipelineId/opportunities/:opportunityId","host":["https://rest.gohighlevel.com"],"path":["v1","pipelines",":pipelineId","opportunities",":opportunityId"],"variable":[{"key":"pipelineId","value":"bCkKGpDsyPP4peuKowkG","description":"(Required) Pipeline Id"},{"key":"opportunityId","value":"123akv4LFn6C9frZoy3e","description":"(Required) Opportunity Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"\"\""},{"id":"2db9be75-46bd-416e-ada6-3c1ed694967a","name":"Bad Request. please contact support!","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/pipelines/:pipelineId/opportunities/:opportunityId","host":["https://rest.gohighlevel.com"],"path":["v1","pipelines",":pipelineId","opportunities",":opportunityId"],"variable":[{"key":"pipelineId","value":"bCkKGpDsyPP4peuKowkG","description":"(Required) Pipeline Id"},{"key":"opportunityId","value":"123akv4LFn6C9frZoy3e","description":"(Required) Opportunity Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"2fdf4d07-5654-498b-a81d-ff8ee101e136","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/pipelines/:pipelineId/opportunities/:opportunityId","host":["https://rest.gohighlevel.com"],"path":["v1","pipelines",":pipelineId","opportunities",":opportunityId"],"variable":[{"key":"pipelineId","value":"bCkKGpDsyPP4peuKowkG","description":"(Required) Pipeline Id"},{"key":"opportunityId","value":"123akv4LFn6C9frZoy3e","description":"(Required) Opportunity Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"be7d2fbc-c9ee-4a43-a55a-f6c1fb8bf3f7"},{"name":"/v1/pipelines/:pipelineId/opportunities/","id":"d888b198-a574-4d38-84d7-c20c2bc50a82","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"First Opp\",\n \"status\": \"open\",\n \"stageId\": \"7915dedc-8f18-44d5-8bc3-77c04e994a10\",\n \"email\": \"elon@musk.com\",\n \"phone\": \"+1202-555-0107\",\n \"assignedTo\": \"082goXVW3lIExEQPOnd3\",\n \"monetaryValue\": 122.22,\n \"source\": \"public api\",\n \"contactId\": \"mTkSCb1UBjb5tk4OvB69\",\n \"name\": \"Elon Musk\",\n \"companyName\": \"Tesla\",\n \"tags\": [\n \"tempor ea adipisicing ut amet\",\n \"voluptate irure\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/pipelines/:pipelineId/opportunities/","description":"

Create opportunity.

Required JSON fields in the body

FieldsTypesExampleAllowed Options
titlestringFirst Opps
stageIdstring7915dedc-8f18-44d5-8bc3-77c04e994a10
contactId (or email or phone)stringmTkSCb1UBjb5tk4OvB69
email (or contactId or phone)stringjohn@deo.com
phone (or contactId or email)string+1202-555-0107
statusstringopen
  • open
  • won
  • lost
  • abandoned

Allowed JSON fields in the body

FieldsTypesExample
monetaryValuenumber220
assignedTostring082goXVW3lIExEQPOnd3
namestringJohn Deo
tagsarray[\"tag1\", \"tag2\"]
companyNamestringTesla Inc

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","pipelines",":pipelineId","opportunities",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"d13966fd-8a18-4455-8624-0b23b64f814e","description":{"content":"

(Required) Pipeline Id

\n","type":"text/plain"},"type":"any","value":"bCkKGpDsyPP4peuKowkG","key":"pipelineId"}]}},"response":[{"id":"d4952c09-87cf-4d9c-876b-0240b95f6ff8","name":"Successful response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"title\": \"First Opp\",\n \"status\": \"open\",\n \"stageId\": \"7915dedc-8f18-44d5-8bc3-77c04e994a10\",\n \"email\": \"elon@musk.com\",\n \"phone\": \"+1202-555-0107\",\n \"assignedTo\": \"082goXVW3lIExEQPOnd3\",\n \"monetaryValue\": 122.22,\n \"source\": \"public api\",\n \"contactId\": \"mTkSCb1UBjb5tk4OvB69\",\n \"name\": \"Elon Musk\",\n \"companyName\": \"Tesla\",\n \"tags\": [\n \"tempor ea adipisicing ut amet\",\n \"voluptate irure\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/pipelines/:pipelineId/opportunities/","host":["https://rest.gohighlevel.com"],"path":["v1","pipelines",":pipelineId","opportunities",""],"variable":[{"key":"pipelineId","value":"bCkKGpDsyPP4peuKowkG","description":"(Required) Pipeline Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"7XExm1wr8gFeZpl6rQny\",\n \"name\": \"First Opp\",\n \"monetaryValue\": 120,\n \"pipelineId\": \"bCkKGpDsyPP4peuKowkG\",\n \"pipelineStageId\": \"8b897c8f-b859-49c1-88f2-ed590708a85c\",\n \"assignedTo\": \"hxHGVRb1YJUscrCB8eXK\",\n \"status\": \"open\",\n \"source\": \"form\",\n \"lastStatusChangeAt\": \"2020-10-29T09:39:35.472Z\",\n \"createdAt\": \"2020-10-29T09:31:30.255Z\",\n \"updatedAt\": \"2020-10-29T09:44:02.263Z\",\n \"contact\": {\n \"id\": \"byMEV0NQinDhq8ZfiOi2\",\n \"name\": \"John Deo\",\n \"companyName\": \"Tesla Inc\",\n \"email\": \"john@deo.com\",\n \"phone\": \"+1202-555-0107\",\n \"tags\": [\n \"occaecat do Lorem\",\n \"magna ipsum in\"\n ]\n }\n}"},{"id":"9094da4c-ad73-45aa-8d11-0314897e253b","name":"Bad Request. please contact support!","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"title\": \"First Opp\",\n \"status\": \"open\",\n \"stageId\": \"7915dedc-8f18-44d5-8bc3-77c04e994a10\",\n \"email\": \"elon@musk.com\",\n \"phone\": \"+1202-555-0107\",\n \"assignedTo\": \"082goXVW3lIExEQPOnd3\",\n \"monetaryValue\": 122.22,\n \"source\": \"public api\",\n \"contactId\": \"mTkSCb1UBjb5tk4OvB69\",\n \"name\": \"Elon Musk\",\n \"companyName\": \"Tesla\",\n \"tags\": [\n \"tempor ea adipisicing ut amet\",\n \"voluptate irure\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/pipelines/:pipelineId/opportunities/","host":["https://rest.gohighlevel.com"],"path":["v1","pipelines",":pipelineId","opportunities",""],"variable":[{"key":"pipelineId","value":"bCkKGpDsyPP4peuKowkG","description":"(Required) Pipeline Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"5b8b893a-d963-4a7b-b491-b2cccc79cd46","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"title\": \"First Opp\",\n \"status\": \"open\",\n \"stageId\": \"7915dedc-8f18-44d5-8bc3-77c04e994a10\",\n \"email\": \"elon@musk.com\",\n \"phone\": \"+1202-555-0107\",\n \"assignedTo\": \"082goXVW3lIExEQPOnd3\",\n \"monetaryValue\": 122.22,\n \"source\": \"public api\",\n \"contactId\": \"mTkSCb1UBjb5tk4OvB69\",\n \"name\": \"Elon Musk\",\n \"companyName\": \"Tesla\",\n \"tags\": [\n \"tempor ea adipisicing ut amet\",\n \"voluptate irure\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/pipelines/:pipelineId/opportunities/","host":["https://rest.gohighlevel.com"],"path":["v1","pipelines",":pipelineId","opportunities",""],"variable":[{"key":"pipelineId","value":"bCkKGpDsyPP4peuKowkG","description":"(Required) Pipeline Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"fd8df6de-2d7f-4c1f-8bab-142dddc09fcd","name":"Unprocessable Entity","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"title\": \"First Opp\",\n \"status\": \"open\",\n \"stageId\": \"7915dedc-8f18-44d5-8bc3-77c04e994a10\",\n \"email\": \"elon@musk.com\",\n \"phone\": \"+1202-555-0107\",\n \"assignedTo\": \"082goXVW3lIExEQPOnd3\",\n \"monetaryValue\": 122.22,\n \"source\": \"public api\",\n \"contactId\": \"mTkSCb1UBjb5tk4OvB69\",\n \"name\": \"Elon Musk\",\n \"companyName\": \"Tesla\",\n \"tags\": [\n \"tempor ea adipisicing ut amet\",\n \"voluptate irure\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/pipelines/:pipelineId/opportunities/","host":["https://rest.gohighlevel.com"],"path":["v1","pipelines",":pipelineId","opportunities",""],"variable":[{"key":"pipelineId","value":"bCkKGpDsyPP4peuKowkG","description":"(Required) Pipeline Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"title\": {\n \"message\": \"The title field is mandatory.\",\n \"rule\": \"required\"\n },\n \"status\": {\n \"message\": \"The status field is mandatory.\",\n \"rule\": \"required\"\n },\n \"stageId\": {\n \"message\": \"The stage id field is mandatory.\",\n \"rule\": \"required\"\n },\n \"contactId or email\": {\n \"message\": \"The contactId or email field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"d888b198-a574-4d38-84d7-c20c2bc50a82"},{"name":"/v1/pipelines/:pipelineId/opportunities/:opportunityId/status","id":"3e60d3e4-d458-42d9-a464-52003f57b731","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": \"open\",\n \"stageId\": \"7915dedc-8f18-44d5-8bc3-77c04e994a10\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/pipelines/:pipelineId/opportunities/:opportunityId/status","description":"

Update opportunity status and stage.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","pipelines",":pipelineId","opportunities",":opportunityId","status"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"e4d4bbd3-1ac7-4d98-9eb5-57c1c0a69c55","description":{"content":"

(Required) Pipeline Id

\n","type":"text/plain"},"type":"any","value":"bCkKGpDsyPP4peuKowkG","key":"pipelineId"},{"id":"7282f583-7799-4518-9fe4-dab5cb47be68","description":{"content":"

(Required) Opportunity Id

\n","type":"text/plain"},"type":"any","value":"123akv4LFn6C9frZoy3e","key":"opportunityId"}]}},"response":[{"id":"b69eb815-ceaf-4d23-8c68-c12577f33233","name":"Successful response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"status\": \"open\",\n \"stageId\": \"7915dedc-8f18-44d5-8bc3-77c04e994a10\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/pipelines/:pipelineId/opportunities/:opportunityId/status","host":["https://rest.gohighlevel.com"],"path":["v1","pipelines",":pipelineId","opportunities",":opportunityId","status"],"variable":[{"key":"pipelineId","value":"bCkKGpDsyPP4peuKowkG","description":"(Required) Pipeline Id"},{"key":"opportunityId","value":"123akv4LFn6C9frZoy3e","description":"(Required) Opportunity Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"\"\""},{"id":"825ac861-c8d9-442d-97ad-cdb8ca670b34","name":"Bad Request. please contact support!","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"status\": \"open\",\n \"stageId\": \"7915dedc-8f18-44d5-8bc3-77c04e994a10\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/pipelines/:pipelineId/opportunities/:opportunityId/status","host":["https://rest.gohighlevel.com"],"path":["v1","pipelines",":pipelineId","opportunities",":opportunityId","status"],"variable":[{"key":"pipelineId","value":"bCkKGpDsyPP4peuKowkG","description":"(Required) Pipeline Id"},{"key":"opportunityId","value":"123akv4LFn6C9frZoy3e","description":"(Required) Opportunity Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"e3f4a728-cfe9-4f2a-a395-f9f5b8cd5e3c","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"status\": \"open\",\n \"stageId\": \"7915dedc-8f18-44d5-8bc3-77c04e994a10\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/pipelines/:pipelineId/opportunities/:opportunityId/status","host":["https://rest.gohighlevel.com"],"path":["v1","pipelines",":pipelineId","opportunities",":opportunityId","status"],"variable":[{"key":"pipelineId","value":"bCkKGpDsyPP4peuKowkG","description":"(Required) Pipeline Id"},{"key":"opportunityId","value":"123akv4LFn6C9frZoy3e","description":"(Required) Opportunity Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"0baf5bfe-083f-4086-942e-2626bffb4878","name":"Unprocessable Entity","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"status\": \"open\",\n \"stageId\": \"7915dedc-8f18-44d5-8bc3-77c04e994a10\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/pipelines/:pipelineId/opportunities/:opportunityId/status","host":["https://rest.gohighlevel.com"],"path":["v1","pipelines",":pipelineId","opportunities",":opportunityId","status"],"variable":[{"key":"pipelineId","value":"bCkKGpDsyPP4peuKowkG","description":"(Required) Pipeline Id"},{"key":"opportunityId","value":"123akv4LFn6C9frZoy3e","description":"(Required) Opportunity Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": {\n \"message\": \"The status field is invalid.\",\n \"rule\": \"invalid\"\n },\n \"stageId\": {\n \"message\": \"The stage id field is invalid.\",\n \"rule\": \"invalid\"\n }\n}"}],"_postman_id":"3e60d3e4-d458-42d9-a464-52003f57b731"}],"id":"5e225942-c518-4c0f-8cad-b8a4447fa803","_postman_id":"5e225942-c518-4c0f-8cad-b8a4447fa803","description":"","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","name":"GoHighLevel API V1.1.20","type":"collection"}}},{"name":"Pipeline","item":[{"name":"/v1/pipelines/","id":"c4380850-67d4-4413-b41d-3de8feb067b3","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/pipelines/","description":"

Get Pipelines.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","pipelines",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[]}},"response":[{"id":"9f93e7f6-b730-4631-a46f-77e98274ed31","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/pipelines/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"pipelines\": [\n {\n \"id\": \"bCkKGpDsyPP4peuKowkG\",\n \"name\": \"First Pipeline\",\n \"stages\": [\n {\n \"id\": \"bCkKGp8b897c8f-b859-49c1-88f2-ed590708a85csyPP4peuKowkG\",\n \"name\": \"First Stage\"\n },\n {\n \"id\": \"bCkKGp8b897c8f-b859-49c1-88f2-ed590708a85csyPP4peuKowkG\",\n \"name\": \"First Stage\"\n }\n ]\n },\n {\n \"id\": \"bCkKGpDsyPP4peuKowkG\",\n \"name\": \"First Pipeline\",\n \"stages\": [\n {\n \"id\": \"bCkKGp8b897c8f-b859-49c1-88f2-ed590708a85csyPP4peuKowkG\",\n \"name\": \"First Stage\"\n },\n {\n \"id\": \"bCkKGp8b897c8f-b859-49c1-88f2-ed590708a85csyPP4peuKowkG\",\n \"name\": \"First Stage\"\n }\n ]\n }\n ]\n}"},{"id":"649e1722-23be-4b71-81d3-11cb1ea85bdf","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/pipelines/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"8b5a937c-fa10-4de9-a59a-4d97435395de","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/pipelines/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"c4380850-67d4-4413-b41d-3de8feb067b3"}],"id":"e2adba5e-2f30-4f80-86ef-f6e1ee9ca42d","_postman_id":"e2adba5e-2f30-4f80-86ef-f6e1ee9ca42d","description":"","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","name":"GoHighLevel API V1.1.20","type":"collection"}}},{"name":"Task","item":[{"name":"/v1/contacts/:contactId/tasks/","id":"ecf71388-a7c1-460e-8743-af2644464985","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/contacts/:contactId/tasks/","description":"

Get all contact tasks.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","contacts",":contactId","tasks",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"44b8d965-20b6-42e8-a434-abdaecb73f57","description":{"content":"

(Required) Contact Id

\n","type":"text/plain"},"type":"any","value":"sx6wyHhbFdRXh302LLNR","key":"contactId"}]}},"response":[{"id":"32e7f7ca-2940-439b-bd92-16842f35e583","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tasks/","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tasks",""],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"tasks\": [\n {\n \"id\": \"Lj371SHlVMyfVlMcKiuk\",\n \"title\": \"Loram ipsum\",\n \"description\": \"Loram ipsum\",\n \"assignedTo\": \"hxHGVRb1YJUscrCB8eXK\",\n \"dueDate\": \"2020-10-25T11:00:00Z\",\n \"isCompleted\": false\n },\n {\n \"id\": \"Lj371SHlVMyfVlMcKiuk\",\n \"title\": \"Loram ipsum\",\n \"description\": \"Loram ipsum\",\n \"assignedTo\": \"hxHGVRb1YJUscrCB8eXK\",\n \"dueDate\": \"2020-10-25T11:00:00Z\",\n \"isCompleted\": false\n }\n ]\n}"},{"id":"8cb5b917-c40d-42d4-aea8-5cda80d8af89","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tasks/","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tasks",""],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"dd091a2b-437f-48d3-b094-82835cea1d5e","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tasks/","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tasks",""],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"ecf71388-a7c1-460e-8743-af2644464985"},{"name":"/v1/contacts/:contactId/tasks/","id":"91a86c5e-9cad-4ec6-8df0-3bbbb0b573d7","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"First Task\",\n \"dueDate\": \"2020-10-25T11:00:00Z\",\n \"description\": \"loram ipsum\",\n \"assignedTo\": \"hxHGVRb1YJUscrCB8eXK\",\n \"status\": \"incompleted\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/contacts/:contactId/tasks/","description":"

Create Tasks.

Status: (optional) Field have following options.

  • completed
  • incompleted (default)
Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","contacts",":contactId","tasks",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"94c04cc2-f55f-4011-b429-ed4ddaba5bb4","description":{"content":"

(Required) Contact Id

\n","type":"text/plain"},"type":"any","value":"sx6wyHhbFdRXh302LLNR","key":"contactId"}]}},"response":[{"id":"c364a7e1-12b7-49b4-81fe-4f0b7d0f4bdb","name":"Successful response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"title\": \"First Task\",\n \"dueDate\": \"2020-10-25T11:00:00Z\",\n \"description\": \"loram ipsum\",\n \"assignedTo\": \"hxHGVRb1YJUscrCB8eXK\",\n \"status\": \"incompleted\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tasks/","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tasks",""],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"Lj371SHlVMyfVlMcKiuk\",\n \"title\": \"Loram ipsum\",\n \"description\": \"Loram ipsum\",\n \"assignedTo\": \"hxHGVRb1YJUscrCB8eXK\",\n \"dueDate\": \"2020-10-25T11:00:00Z\",\n \"isCompleted\": false\n}"},{"id":"f15be170-0c70-4121-bcc0-905fdba4284b","name":"Bad Request. please contact support!","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"title\": \"First Task\",\n \"dueDate\": \"2020-10-25T11:00:00Z\",\n \"description\": \"loram ipsum\",\n \"assignedTo\": \"hxHGVRb1YJUscrCB8eXK\",\n \"status\": \"incompleted\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tasks/","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tasks",""],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"64c14021-131c-44e3-a756-786535c14413","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"title\": \"First Task\",\n \"dueDate\": \"2020-10-25T11:00:00Z\",\n \"description\": \"loram ipsum\",\n \"assignedTo\": \"hxHGVRb1YJUscrCB8eXK\",\n \"status\": \"incompleted\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tasks/","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tasks",""],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"097e2495-120c-45cd-81f9-90189ec84adf","name":"Unprocessable Entity","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"title\": \"First Task\",\n \"dueDate\": \"2020-10-25T11:00:00Z\",\n \"description\": \"loram ipsum\",\n \"assignedTo\": \"hxHGVRb1YJUscrCB8eXK\",\n \"status\": \"incompleted\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tasks/","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tasks",""],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"title\": {\n \"message\": \"The title field is mandatory.\",\n \"rule\": \"required\"\n },\n \"dueDate\": {\n \"message\": \"The due date field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"91a86c5e-9cad-4ec6-8df0-3bbbb0b573d7"},{"name":"/v1/contacts/:contactId/tasks/:taskId","id":"177ea1f7-3f75-4096-92bd-7e3df498c39d","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/contacts/:contactId/tasks/:taskId","description":"

Get task by id.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","contacts",":contactId","tasks",":taskId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"61521a6c-653f-46ef-b78c-0ae6c174ba39","description":{"content":"

(Required) Contact Id

\n","type":"text/plain"},"type":"any","value":"sx6wyHhbFdRXh302LLNR","key":"contactId"},{"id":"dfedc74c-adf6-4f6e-8168-efb8c9ad100f","description":{"content":"

(Required) Task Id

\n","type":"text/plain"},"type":"any","value":"ocQHyuzHvysMo5N5VsXc","key":"taskId"}]}},"response":[{"id":"5950cd23-28a2-43f9-b62b-633108c4dc51","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tasks/:taskId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tasks",":taskId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"taskId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Task Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"Lj371SHlVMyfVlMcKiuk\",\n \"title\": \"Loram ipsum\",\n \"description\": \"Loram ipsum\",\n \"assignedTo\": \"hxHGVRb1YJUscrCB8eXK\",\n \"dueDate\": \"2020-10-25T11:00:00Z\",\n \"isCompleted\": false\n}"},{"id":"fb549f4e-398f-43fd-b3bc-77f41dfa5bad","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tasks/:taskId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tasks",":taskId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"taskId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Task Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"6cf951e4-6005-47f0-be0a-f2bbae07b4ff","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tasks/:taskId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tasks",":taskId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"taskId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Task Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"177ea1f7-3f75-4096-92bd-7e3df498c39d"},{"name":"/v1/contacts/:contactId/tasks/:taskId","id":"20696372-63c5-4353-ae14-19c3114c309c","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"title\": \"First Task\",\n \"dueDate\": \"2020-10-25T11:00:00Z\",\n \"description\": \"loram ipsum\",\n \"assignedTo\": \"hxHGVRb1YJUscrCB8eXK\",\n \"status\": \"incompleted\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/contacts/:contactId/tasks/:taskId","description":"

Update Task.

Status: (optional) Field have following options.

  • completed
  • incompleted (default)
Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","contacts",":contactId","tasks",":taskId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"1db78302-60f8-4be4-8ffb-4f7a21cc3011","description":{"content":"

(Required) Contact Id

\n","type":"text/plain"},"type":"any","value":"sx6wyHhbFdRXh302LLNR","key":"contactId"},{"id":"c461cd3a-af76-4280-8298-9c459b0a2536","description":{"content":"

(Required) Task Id

\n","type":"text/plain"},"type":"any","value":"ocQHyuzHvysMo5N5VsXc","key":"taskId"}]}},"response":[{"id":"fb1ee09a-81a8-4c06-9173-c6f600f82220","name":"Successful response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"title\": \"First Task\",\n \"dueDate\": \"2020-10-25T11:00:00Z\",\n \"description\": \"loram ipsum\",\n \"assignedTo\": \"hxHGVRb1YJUscrCB8eXK\",\n \"status\": \"incompleted\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tasks/:taskId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tasks",":taskId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"taskId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Task Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"Lj371SHlVMyfVlMcKiuk\",\n \"title\": \"Loram ipsum\",\n \"description\": \"Loram ipsum\",\n \"assignedTo\": \"hxHGVRb1YJUscrCB8eXK\",\n \"dueDate\": \"2020-10-25T11:00:00Z\",\n \"isCompleted\": false\n}"},{"id":"a99e2ae7-08ea-44de-8e11-9023d498283e","name":"Bad Request. please contact support!","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"title\": \"First Task\",\n \"dueDate\": \"2020-10-25T11:00:00Z\",\n \"description\": \"loram ipsum\",\n \"assignedTo\": \"hxHGVRb1YJUscrCB8eXK\",\n \"status\": \"incompleted\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tasks/:taskId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tasks",":taskId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"taskId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Task Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"14584e7e-9d50-4ec2-aab8-bfe9c07bf5b3","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"title\": \"First Task\",\n \"dueDate\": \"2020-10-25T11:00:00Z\",\n \"description\": \"loram ipsum\",\n \"assignedTo\": \"hxHGVRb1YJUscrCB8eXK\",\n \"status\": \"incompleted\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tasks/:taskId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tasks",":taskId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"taskId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Task Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"9214c04f-0bd2-4b66-b3a7-2e455e14d294","name":"Unprocessable Entity","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"title\": \"First Task\",\n \"dueDate\": \"2020-10-25T11:00:00Z\",\n \"description\": \"loram ipsum\",\n \"assignedTo\": \"hxHGVRb1YJUscrCB8eXK\",\n \"status\": \"incompleted\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tasks/:taskId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tasks",":taskId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"taskId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Task Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"title\": {\n \"message\": \"The title field is mandatory.\",\n \"rule\": \"required\"\n },\n \"dueDate\": {\n \"message\": \"The due date field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"20696372-63c5-4353-ae14-19c3114c309c"},{"name":"/v1/contacts/:contactId/tasks/:taskId","id":"2219f2a4-7c24-4649-ad71-33ebbc63805e","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"DELETE","header":[],"url":"https://rest.gohighlevel.com/v1/contacts/:contactId/tasks/:taskId","description":"

Delete one of Task.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","contacts",":contactId","tasks",":taskId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"bb08f75a-850d-4d95-b4d1-226d8f9f7ac6","description":{"content":"

(Required) Contact Id

\n","type":"text/plain"},"type":"any","value":"sx6wyHhbFdRXh302LLNR","key":"contactId"},{"id":"b5d56d17-3865-4fac-b0fe-d9d811aa85e9","description":{"content":"

(Required) Task Id

\n","type":"text/plain"},"type":"any","value":"ocQHyuzHvysMo5N5VsXc","key":"taskId"}]}},"response":[{"id":"2bcbe6b2-52ac-4d54-ae50-4a279b3b862e","name":"Successful response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tasks/:taskId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tasks",":taskId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"taskId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Task Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"\"\""},{"id":"47516466-1668-4817-a110-b1d101118ba9","name":"Bad Request. please contact support!","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tasks/:taskId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tasks",":taskId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"taskId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Task Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"b3ef1b4a-7420-4e8d-918c-52589ff92802","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tasks/:taskId","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tasks",":taskId"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"taskId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Task Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"2219f2a4-7c24-4649-ad71-33ebbc63805e"},{"name":"/v1/contacts/:contactId/tasks/:taskId/status","id":"77a08f7b-4e91-4514-b98d-b2955631c9de","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": \"completed\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/contacts/:contactId/tasks/:taskId/status","description":"

Update Task status.

Status: Field have following option

  • completed
  • incompleted
Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","contacts",":contactId","tasks",":taskId","status"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"85104645-cfa9-4ac7-9639-d30a1e334656","description":{"content":"

(Required) Contact Id

\n","type":"text/plain"},"type":"any","value":"sx6wyHhbFdRXh302LLNR","key":"contactId"},{"id":"e8ea579f-69f7-4323-9421-6f17c543d70a","description":{"content":"

(Required) Task Id

\n","type":"text/plain"},"type":"any","value":"ocQHyuzHvysMo5N5VsXc","key":"taskId"}]}},"response":[{"id":"8814b34b-e3a5-465c-843e-404aaaa11c77","name":"Successful response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"status\": \"completed\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tasks/:taskId/status","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tasks",":taskId","status"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"taskId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Task Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"Lj371SHlVMyfVlMcKiuk\",\n \"title\": \"Loram ipsum\",\n \"description\": \"Loram ipsum\",\n \"assignedTo\": \"hxHGVRb1YJUscrCB8eXK\",\n \"dueDate\": \"2020-10-25T11:00:00Z\",\n \"isCompleted\": false\n}"},{"id":"e4d58c43-560c-4550-b800-88a323e50d57","name":"Bad Request. please contact support!","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"status\": \"completed\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tasks/:taskId/status","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tasks",":taskId","status"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"taskId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Task Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"49eb661e-8be6-433b-8a5e-845f0ef2e16d","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"status\": \"completed\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tasks/:taskId/status","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tasks",":taskId","status"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"taskId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Task Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"8adfe7a3-8a6e-4dbc-b404-48badc8e6d30","name":"Unprocessable Entity","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"status\": \"completed\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/contacts/:contactId/tasks/:taskId/status","host":["https://rest.gohighlevel.com"],"path":["v1","contacts",":contactId","tasks",":taskId","status"],"variable":[{"key":"contactId","value":"sx6wyHhbFdRXh302LLNR","description":"(Required) Contact Id"},{"key":"taskId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Task Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"title\": {\n \"message\": \"The title field is mandatory.\",\n \"rule\": \"required\"\n },\n \"dueDate\": {\n \"message\": \"The due date field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"77a08f7b-4e91-4514-b98d-b2955631c9de"}],"id":"9769603e-1c93-4732-9f59-22a11fd9979e","_postman_id":"9769603e-1c93-4732-9f59-22a11fd9979e","description":"","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","name":"GoHighLevel API V1.1.20","type":"collection"}}},{"name":"Tag","item":[{"name":"/v1/tags/","id":"7ceb9417-f402-446a-bfe0-198d757aeb5a","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/tags/","description":"

Get Tags.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","tags",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[]}},"response":[{"id":"52b0d40c-830b-49e8-8c56-b62ac49aa057","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/tags/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"tags\": [\n {\n \"id\": \"kAllGzwHkSVZC11GYKF9\",\n \"name\": \"Hello\"\n },\n {\n \"id\": \"kAllGzwHkSVZC11GYKF9\",\n \"name\": \"Hello\"\n }\n ]\n}"},{"id":"dc355b08-62a4-4f39-abbf-154b94e32013","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/tags/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"7fb8fd32-3608-4190-bd97-8a1a0daf6895","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/tags/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"7ceb9417-f402-446a-bfe0-198d757aeb5a"},{"name":"/v1/tags/","id":"72b82a2a-79fe-4d11-8f79-42250debc739","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"first tag\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/tags/","description":"

Create Tag.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","tags",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[]}},"response":[{"id":"af399dc8-72a6-4bee-83c9-4680f73a9efb","name":"Successful response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"first tag\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/tags/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"kAllGzwHkSVZC11GYKF9\",\n \"name\": \"Hello\"\n}"},{"id":"f892cbeb-a8e9-41b3-b107-55e93a0c6b23","name":"Bad Request. please contact support!","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"first tag\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/tags/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"8d7f903e-fd2a-45ad-b8bd-f12c3bfb6d8e","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"first tag\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/tags/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"9a15be0e-0c0c-45d7-81d8-c02a41a70880","name":"Unprocessable Entity","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"first tag\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/tags/"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": {\n \"message\": \"The name field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"72b82a2a-79fe-4d11-8f79-42250debc739"},{"name":"/v1/tags/:tagId","id":"6299d6cd-496b-4215-8d23-5c5095dac3c4","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/tags/:tagId","description":"

Get tag by id.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","tags",":tagId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"2e53985b-062d-4fc3-8432-8110beb0479b","description":{"content":"

(Required) Tag Id

\n","type":"text/plain"},"type":"any","value":"ocQHyuzHvysMo5N5VsXc","key":"tagId"}]}},"response":[{"id":"60d8f952-455b-4687-908b-24d51cc023bf","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/tags/:tagId","host":["https://rest.gohighlevel.com"],"path":["v1","tags",":tagId"],"variable":[{"key":"tagId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Tag Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"kAllGzwHkSVZC11GYKF9\",\n \"name\": \"Hello\"\n}"},{"id":"c9f3c766-a29e-4e80-abbf-8d222d352c84","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/tags/:tagId","host":["https://rest.gohighlevel.com"],"path":["v1","tags",":tagId"],"variable":[{"key":"tagId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Tag Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"47cb56e9-c542-4d46-ba5a-4f0eda01aa55","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/tags/:tagId","host":["https://rest.gohighlevel.com"],"path":["v1","tags",":tagId"],"variable":[{"key":"tagId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Tag Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"6299d6cd-496b-4215-8d23-5c5095dac3c4"},{"name":"/v1/tags/:tagId","id":"63e11b51-2111-485f-b5e5-216e6e10b7cf","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"first tag\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/tags/:tagId","description":"

Update tag.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","tags",":tagId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"415634ea-9cc7-4186-8032-defe1e87a958","description":{"content":"

(Required) Tag Id

\n","type":"text/plain"},"type":"any","value":"ocQHyuzHvysMo5N5VsXc","key":"tagId"}]}},"response":[{"id":"4099799e-47ac-44c0-b449-61724b6104ca","name":"Successful response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"first tag\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/tags/:tagId","host":["https://rest.gohighlevel.com"],"path":["v1","tags",":tagId"],"variable":[{"key":"tagId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Tag Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"kAllGzwHkSVZC11GYKF9\",\n \"name\": \"Hello\"\n}"},{"id":"28dd1047-4b8c-4529-a606-8b651e9635ea","name":"Bad Request. please contact support!","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"first tag\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/tags/:tagId","host":["https://rest.gohighlevel.com"],"path":["v1","tags",":tagId"],"variable":[{"key":"tagId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Tag Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"853261cc-04d5-466c-8a3e-37194ae496e4","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"first tag\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/tags/:tagId","host":["https://rest.gohighlevel.com"],"path":["v1","tags",":tagId"],"variable":[{"key":"tagId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Tag Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"96e1964d-084d-46d4-a037-7b0c46647509","name":"Unprocessable Entity","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"first tag\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/tags/:tagId","host":["https://rest.gohighlevel.com"],"path":["v1","tags",":tagId"],"variable":[{"key":"tagId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Tag Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": {\n \"message\": \"The name field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"63e11b51-2111-485f-b5e5-216e6e10b7cf"},{"name":"/v1/tags/:tagId","id":"b4bf0d05-56c2-4b43-bc6e-0083a173454a","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"DELETE","header":[],"url":"https://rest.gohighlevel.com/v1/tags/:tagId","description":"

Delete one of tag.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","tags",":tagId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"6aa72b75-a544-4e63-88bb-900f1978cc8b","description":{"content":"

(Required) Custom Value Id

\n","type":"text/plain"},"type":"any","value":"ocQHyuzHvysMo5N5VsXc","key":"tagId"}]}},"response":[{"id":"43a3ecac-c704-48c3-ac10-d097bd4d7bd2","name":"Successful response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/tags/:tagId","host":["https://rest.gohighlevel.com"],"path":["v1","tags",":tagId"],"variable":[{"key":"tagId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Custom Value Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"\"\""},{"id":"c87ce108-3b1f-4188-99f1-01563fa7aa98","name":"Bad Request. please contact support!","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/tags/:tagId","host":["https://rest.gohighlevel.com"],"path":["v1","tags",":tagId"],"variable":[{"key":"tagId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Custom Value Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"cfe5e4e7-d278-42f2-94df-e9934dcdae87","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/tags/:tagId","host":["https://rest.gohighlevel.com"],"path":["v1","tags",":tagId"],"variable":[{"key":"tagId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Custom Value Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"907f11cd-11dd-4afd-844a-718c5591a8d9","name":"Unprocessable Entity","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/tags/:tagId","host":["https://rest.gohighlevel.com"],"path":["v1","tags",":tagId"],"variable":[{"key":"tagId","value":"ocQHyuzHvysMo5N5VsXc","description":"(Required) Custom Value Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"customValueId\": {\n \"message\": \"The custom field id is invalid.\",\n \"rule\": \"invalid\"\n }\n}"}],"_postman_id":"b4bf0d05-56c2-4b43-bc6e-0083a173454a"}],"id":"c382a695-f531-4fa4-91ae-cb5f34337476","_postman_id":"c382a695-f531-4fa4-91ae-cb5f34337476","description":"","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","name":"GoHighLevel API V1.1.20","type":"collection"}}},{"name":"Timezone","item":[{"name":"/v1/timezones/","id":"744e1824-acbe-4cb1-b322-25eb7493bdb5","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/timezones/","description":"

Get timezone list.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","timezones",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[]}},"response":[{"id":"0528e0f1-8d9e-49da-bc7d-3dcccfc713ce","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/timezones/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"timezones\": [\n \"UTC\",\n \"UTC\"\n ]\n}"},{"id":"c5166dd6-b84c-4150-86f3-bc8b255009d8","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/timezones/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"046b9621-57c8-46f9-859b-4731e3eac0dc","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/timezones/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"744e1824-acbe-4cb1-b322-25eb7493bdb5"}],"id":"098e1836-111e-4b6f-b1d9-112f15e6c670","_postman_id":"098e1836-111e-4b6f-b1d9-112f15e6c670","description":"","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","name":"GoHighLevel API V1.1.20","type":"collection"}}},{"name":"Trigger Links","item":[{"name":"/v1/links/","id":"91ab547a-1e26-471f-8791-a24cc33e6053","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/links/","description":"

Get Links.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","links",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[]}},"response":[{"id":"932c81bf-d524-475e-adeb-cbe7290bebf8","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/links/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"links\": [\n {\n \"id\": \"ikMFj5x3rrKOQgu0k8y1\",\n \"name\": \"Trigger Link\",\n \"redirectTo\": \"https://www.google.com/\",\n \"fieldKey\": \"{{trigger_link.ClK3HFY3WH9L5McNwyy1}}\",\n \"locationId\": \"Lx1EI6YIgQYMQi0ytFXv\"\n },\n {\n \"id\": \"ikMFj5x3rrKOQgu0k8y1\",\n \"name\": \"Trigger Link\",\n \"redirectTo\": \"https://www.google.com/\",\n \"fieldKey\": \"{{trigger_link.ClK3HFY3WH9L5McNwyy1}}\",\n \"locationId\": \"Lx1EI6YIgQYMQi0ytFXv\"\n }\n ]\n}"},{"id":"b1d8ce68-cd6b-4985-aa6d-b0f6408ac647","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/links/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"14a2fddd-434b-4207-a7e9-ad3c994b6da8","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/links/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"91ab547a-1e26-471f-8791-a24cc33e6053"},{"name":"/v1/links/","id":"0bfa7afc-190a-4e40-9f98-5dbf22ba5d17","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"first tag\",\n \"redirectTo\": \"https://www.google.com/\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/links/","description":"

Create trigger link.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","links",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[]}},"response":[{"id":"6d4be116-a42a-4011-9cce-a712713ce4c6","name":"Successful response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"first tag\",\n \"redirectTo\": \"https://www.google.com/\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/links/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"ikMFj5x3rrKOQgu0k8y1\",\n \"name\": \"Trigger Link\",\n \"redirectTo\": \"https://www.google.com/\",\n \"fieldKey\": \"{{trigger_link.ClK3HFY3WH9L5McNwyy1}}\",\n \"locationId\": \"Lx1EI6YIgQYMQi0ytFXv\"\n}"},{"id":"03f9fb4b-f13a-4048-9173-49ae3346b207","name":"Bad Request. please contact support!","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"first tag\",\n \"redirectTo\": \"https://www.google.com/\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/links/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"0b45c209-fa8e-4025-ac8b-4be7c4f95b99","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"first tag\",\n \"redirectTo\": \"https://www.google.com/\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/links/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"21f22fcc-b031-4809-81b1-14fcbc0e47dd","name":"Unprocessable Entity","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"first tag\",\n \"redirectTo\": \"https://www.google.com/\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/links/"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": {\n \"message\": \"The name field is mandatory.\",\n \"rule\": \"required\"\n },\n \"redirectTo\": {\n \"message\": \"The redirect to field is mandatory.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"0bfa7afc-190a-4e40-9f98-5dbf22ba5d17"},{"name":"/v1/links/:linkId","id":"3a0b2335-3c64-4e35-a283-2253a6427fa2","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"first tag\",\n \"redirectTo\": \"https://www.google.com/\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/links/:linkId","description":"

Update trigger links.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","links",":linkId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"e4869222-bb6e-4267-9409-14938c1ec2f2","description":{"content":"

(Required) Link Id

\n","type":"text/plain"},"type":"any","value":"ClK3HFY3WH9L5McNwyy1","key":"linkId"}]}},"response":[{"id":"889c07fb-b8cf-44c4-902a-919fc8aa419b","name":"Successful response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"first tag\",\n \"redirectTo\": \"https://www.google.com/\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/links/:linkId","host":["https://rest.gohighlevel.com"],"path":["v1","links",":linkId"],"variable":[{"key":"linkId","value":"ClK3HFY3WH9L5McNwyy1","description":"(Required) Link Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"ikMFj5x3rrKOQgu0k8y1\",\n \"name\": \"Trigger Link\",\n \"redirectTo\": \"https://www.google.com/\",\n \"fieldKey\": \"{{trigger_link.ClK3HFY3WH9L5McNwyy1}}\",\n \"locationId\": \"Lx1EI6YIgQYMQi0ytFXv\"\n}"},{"id":"ec78fb80-c0ef-499f-9165-cb5b989c1573","name":"Bad Request. please contact support!","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"first tag\",\n \"redirectTo\": \"https://www.google.com/\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/links/:linkId","host":["https://rest.gohighlevel.com"],"path":["v1","links",":linkId"],"variable":[{"key":"linkId","value":"ClK3HFY3WH9L5McNwyy1","description":"(Required) Link Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"a35f4cae-2be7-457c-8b71-2477f3c55aca","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"first tag\",\n \"redirectTo\": \"https://www.google.com/\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/links/:linkId","host":["https://rest.gohighlevel.com"],"path":["v1","links",":linkId"],"variable":[{"key":"linkId","value":"ClK3HFY3WH9L5McNwyy1","description":"(Required) Link Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"ce74418f-d24c-44e4-b733-08ab60318e4a","name":"Unprocessable Entity","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"name\": \"first tag\",\n \"redirectTo\": \"https://www.google.com/\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/links/:linkId","host":["https://rest.gohighlevel.com"],"path":["v1","links",":linkId"],"variable":[{"key":"linkId","value":"ClK3HFY3WH9L5McNwyy1","description":"(Required) Link Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"linkId\": {\n \"message\": \"The link id is invalid.\",\n \"rule\": \"invalid\"\n }\n}"}],"_postman_id":"3a0b2335-3c64-4e35-a283-2253a6427fa2"},{"name":"/v1/links/:linkId","id":"0709a194-844a-42b2-b0b4-c419311f6ce5","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"DELETE","header":[],"url":"https://rest.gohighlevel.com/v1/links/:linkId","description":"

Delete one of trigger links.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","links",":linkId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"a6018b74-20f8-44ce-9580-c31e4a715ef5","description":{"content":"

(Required) Link Id Id

\n","type":"text/plain"},"type":"any","value":"ClK3HFY3WH9L5McNwyy1","key":"linkId"}]}},"response":[{"id":"168fda7f-b35f-4188-99e1-e458c538687d","name":"Successful response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/links/:linkId","host":["https://rest.gohighlevel.com"],"path":["v1","links",":linkId"],"variable":[{"key":"linkId","value":"ClK3HFY3WH9L5McNwyy1","description":"(Required) Link Id Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"\"\""},{"id":"35596714-80d8-4828-89f7-3d76d762e8a1","name":"Bad Request. please contact support!","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/links/:linkId","host":["https://rest.gohighlevel.com"],"path":["v1","links",":linkId"],"variable":[{"key":"linkId","value":"ClK3HFY3WH9L5McNwyy1","description":"(Required) Link Id Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"e3c7f720-d88a-4e16-9af4-0ec984289bb0","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/links/:linkId","host":["https://rest.gohighlevel.com"],"path":["v1","links",":linkId"],"variable":[{"key":"linkId","value":"ClK3HFY3WH9L5McNwyy1","description":"(Required) Link Id Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"02cc7151-3e8a-4266-b1eb-4a5bc452b358","name":"Unprocessable Entity","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/links/:linkId","host":["https://rest.gohighlevel.com"],"path":["v1","links",":linkId"],"variable":[{"key":"linkId","value":"ClK3HFY3WH9L5McNwyy1","description":"(Required) Link Id Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"linkId\": {\n \"message\": \"The link id is invalid.\",\n \"rule\": \"invalid\"\n }\n}"}],"_postman_id":"0709a194-844a-42b2-b0b4-c419311f6ce5"}],"id":"0551d660-b758-4bbc-b334-0edae685f660","_postman_id":"0551d660-b758-4bbc-b334-0edae685f660","description":"","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","name":"GoHighLevel API V1.1.20","type":"collection"}}},{"name":"User","item":[{"name":"/v1/users/","id":"666ff83e-3044-442d-82b2-9e257938460a","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/users/?locationId=i2SpAtBVHSVea1sL6oah","description":"

Get all agency users.

Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys

","urlObject":{"path":["v1","users",""],"host":["https://rest.gohighlevel.com"],"query":[{"description":{"content":"

(Optional) Filter users by location.

\n","type":"text/plain"},"key":"locationId","value":"i2SpAtBVHSVea1sL6oah"}],"variable":[]}},"response":[{"id":"9c820678-f06a-4246-9329-87953ff580d1","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/users/?locationId=i2SpAtBVHSVea1sL6oah","host":["https://rest.gohighlevel.com"],"path":["v1","users",""],"query":[{"key":"locationId","value":"i2SpAtBVHSVea1sL6oah"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"users\": [\n {\n \"id\": \"3g3ltlwEJBoXArLowV3e\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"roles\": {\n \"type\": \"agency\",\n \"role\": \"admin\",\n \"locationIds\": [\n \"C2QujeCh8ZnC7al2InWR\"\n ]\n },\n \"permissions\": {\n \"campaignsEnabled\": true,\n \"campaignsReadOnly\": false,\n \"contactsEnabled\": true,\n \"workflowsEnabled\": true,\n \"triggersEnabled\": true,\n \"funnelsEnabled\": true,\n \"websitesEnabled\": false,\n \"opportunitiesEnabled\": true,\n \"dashboardStatsEnabled\": true,\n \"bulkRequestsEnabled\": true,\n \"appointmentsEnabled\": true,\n \"reviewsEnabled\": true,\n \"onlineListingsEnabled\": true,\n \"phoneCallEnabled\": true,\n \"conversationsEnabled\": true,\n \"assignedDataOnly\": false,\n \"adwordsReportingEnabled\": false,\n \"membershipEnabled\": false,\n \"facebookAdsReportingEnabled\": false,\n \"attributionsReportingEnabled\": false,\n \"settingsEnabled\": true,\n \"tagsEnabled\": true,\n \"leadValueEnabled\": true,\n \"marketingEnabled\": true\n }\n },\n {\n \"id\": \"3g3ltlwEJBoXArLowV3e\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"roles\": {\n \"type\": \"agency\",\n \"role\": \"admin\",\n \"locationIds\": [\n \"C2QujeCh8ZnC7al2InWR\"\n ]\n },\n \"permissions\": {\n \"campaignsEnabled\": true,\n \"campaignsReadOnly\": false,\n \"contactsEnabled\": true,\n \"workflowsEnabled\": true,\n \"triggersEnabled\": true,\n \"funnelsEnabled\": true,\n \"websitesEnabled\": false,\n \"opportunitiesEnabled\": true,\n \"dashboardStatsEnabled\": true,\n \"bulkRequestsEnabled\": true,\n \"appointmentsEnabled\": true,\n \"reviewsEnabled\": true,\n \"onlineListingsEnabled\": true,\n \"phoneCallEnabled\": true,\n \"conversationsEnabled\": true,\n \"assignedDataOnly\": false,\n \"adwordsReportingEnabled\": false,\n \"membershipEnabled\": false,\n \"facebookAdsReportingEnabled\": false,\n \"attributionsReportingEnabled\": false,\n \"settingsEnabled\": true,\n \"tagsEnabled\": true,\n \"leadValueEnabled\": true,\n \"marketingEnabled\": true\n }\n }\n ]\n}"},{"id":"9536df16-2142-4247-8096-c5082aa4c268","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/users/?locationId=i2SpAtBVHSVea1sL6oah","host":["https://rest.gohighlevel.com"],"path":["v1","users",""],"query":[{"key":"locationId","value":"i2SpAtBVHSVea1sL6oah"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"6925733d-581b-4b22-9775-2b13406696d6","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/users/?locationId=i2SpAtBVHSVea1sL6oah","host":["https://rest.gohighlevel.com"],"path":["v1","users",""],"query":[{"key":"locationId","value":"i2SpAtBVHSVea1sL6oah"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"666ff83e-3044-442d-82b2-9e257938460a"},{"name":"/v1/users/","id":"b264ba5b-d9f1-4bc4-9083-8e924e05f22f","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"password\": \"*******\",\n \"type\": \"account\",\n \"role\": \"admin\",\n \"locationIds\": [\n \"C2QujeCh8ZnC7al2InWR\"\n ],\n \"permissions\": {\n \"campaignsEnabled\": true,\n \"campaignsReadOnly\": false,\n \"contactsEnabled\": true,\n \"workflowsEnabled\": true,\n \"triggersEnabled\": true,\n \"funnelsEnabled\": true,\n \"websitesEnabled\": false,\n \"opportunitiesEnabled\": true,\n \"dashboardStatsEnabled\": true,\n \"bulkRequestsEnabled\": true,\n \"appointmentsEnabled\": true,\n \"reviewsEnabled\": true,\n \"onlineListingsEnabled\": true,\n \"phoneCallEnabled\": true,\n \"conversationsEnabled\": true,\n \"assignedDataOnly\": false,\n \"adwordsReportingEnabled\": false,\n \"membershipEnabled\": false,\n \"facebookAdsReportingEnabled\": false,\n \"attributionsReportingEnabled\": false,\n \"settingsEnabled\": true,\n \"tagsEnabled\": true,\n \"leadValueEnabled\": true,\n \"marketingEnabled\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/users/","description":"

Create a User.

Small description for the field allow options.

type fields will allow these options:

  • account
  • agency

role fields will allow these options:

  • admin
  • user

locationIds fields will allow valid locations id of the agency.

Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys

","urlObject":{"path":["v1","users",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[]}},"response":[{"id":"b4689d21-aacb-4c4b-bf0e-3754c0886d6c","name":"Successful response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"password\": \"*******\",\n \"type\": \"account\",\n \"role\": \"admin\",\n \"locationIds\": [\n \"C2QujeCh8ZnC7al2InWR\"\n ],\n \"permissions\": {\n \"campaignsEnabled\": true,\n \"campaignsReadOnly\": false,\n \"contactsEnabled\": true,\n \"workflowsEnabled\": true,\n \"triggersEnabled\": true,\n \"funnelsEnabled\": true,\n \"websitesEnabled\": false,\n \"opportunitiesEnabled\": true,\n \"dashboardStatsEnabled\": true,\n \"bulkRequestsEnabled\": true,\n \"appointmentsEnabled\": true,\n \"reviewsEnabled\": true,\n \"onlineListingsEnabled\": true,\n \"phoneCallEnabled\": true,\n \"conversationsEnabled\": true,\n \"assignedDataOnly\": false,\n \"adwordsReportingEnabled\": false,\n \"membershipEnabled\": false,\n \"facebookAdsReportingEnabled\": false,\n \"attributionsReportingEnabled\": false,\n \"settingsEnabled\": true,\n \"tagsEnabled\": true,\n \"leadValueEnabled\": true,\n \"marketingEnabled\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/users/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"3g3ltlwEJBoXArLowV3e\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"roles\": {\n \"type\": \"agency\",\n \"role\": \"admin\",\n \"locationIds\": [\n \"C2QujeCh8ZnC7al2InWR\"\n ]\n },\n \"permissions\": {\n \"campaignsEnabled\": true,\n \"campaignsReadOnly\": false,\n \"contactsEnabled\": true,\n \"workflowsEnabled\": true,\n \"triggersEnabled\": true,\n \"funnelsEnabled\": true,\n \"websitesEnabled\": false,\n \"opportunitiesEnabled\": true,\n \"dashboardStatsEnabled\": true,\n \"bulkRequestsEnabled\": true,\n \"appointmentsEnabled\": true,\n \"reviewsEnabled\": true,\n \"onlineListingsEnabled\": true,\n \"phoneCallEnabled\": true,\n \"conversationsEnabled\": true,\n \"assignedDataOnly\": false,\n \"adwordsReportingEnabled\": false,\n \"membershipEnabled\": false,\n \"facebookAdsReportingEnabled\": false,\n \"attributionsReportingEnabled\": false,\n \"settingsEnabled\": true,\n \"tagsEnabled\": true,\n \"leadValueEnabled\": true,\n \"marketingEnabled\": true\n }\n}"},{"id":"c3eb497f-4ab5-456c-91b4-3619d9e0fc03","name":"Bad Request. please contact support!","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"password\": \"*******\",\n \"type\": \"account\",\n \"role\": \"admin\",\n \"locationIds\": [\n \"C2QujeCh8ZnC7al2InWR\"\n ],\n \"permissions\": {\n \"campaignsEnabled\": true,\n \"campaignsReadOnly\": false,\n \"contactsEnabled\": true,\n \"workflowsEnabled\": true,\n \"triggersEnabled\": true,\n \"funnelsEnabled\": true,\n \"websitesEnabled\": false,\n \"opportunitiesEnabled\": true,\n \"dashboardStatsEnabled\": true,\n \"bulkRequestsEnabled\": true,\n \"appointmentsEnabled\": true,\n \"reviewsEnabled\": true,\n \"onlineListingsEnabled\": true,\n \"phoneCallEnabled\": true,\n \"conversationsEnabled\": true,\n \"assignedDataOnly\": false,\n \"adwordsReportingEnabled\": false,\n \"membershipEnabled\": false,\n \"facebookAdsReportingEnabled\": false,\n \"attributionsReportingEnabled\": false,\n \"settingsEnabled\": true,\n \"tagsEnabled\": true,\n \"leadValueEnabled\": true,\n \"marketingEnabled\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/users/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"f67edf7d-25e7-4684-a50e-da5538712285","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"password\": \"*******\",\n \"type\": \"account\",\n \"role\": \"admin\",\n \"locationIds\": [\n \"C2QujeCh8ZnC7al2InWR\"\n ],\n \"permissions\": {\n \"campaignsEnabled\": true,\n \"campaignsReadOnly\": false,\n \"contactsEnabled\": true,\n \"workflowsEnabled\": true,\n \"triggersEnabled\": true,\n \"funnelsEnabled\": true,\n \"websitesEnabled\": false,\n \"opportunitiesEnabled\": true,\n \"dashboardStatsEnabled\": true,\n \"bulkRequestsEnabled\": true,\n \"appointmentsEnabled\": true,\n \"reviewsEnabled\": true,\n \"onlineListingsEnabled\": true,\n \"phoneCallEnabled\": true,\n \"conversationsEnabled\": true,\n \"assignedDataOnly\": false,\n \"adwordsReportingEnabled\": false,\n \"membershipEnabled\": false,\n \"facebookAdsReportingEnabled\": false,\n \"attributionsReportingEnabled\": false,\n \"settingsEnabled\": true,\n \"tagsEnabled\": true,\n \"leadValueEnabled\": true,\n \"marketingEnabled\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/users/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"6c6bf56a-1252-4231-af52-d0b2f4ef99fe","name":"Unprocessable Entity","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"password\": \"*******\",\n \"type\": \"account\",\n \"role\": \"admin\",\n \"locationIds\": [\n \"C2QujeCh8ZnC7al2InWR\"\n ],\n \"permissions\": {\n \"campaignsEnabled\": true,\n \"campaignsReadOnly\": false,\n \"contactsEnabled\": true,\n \"workflowsEnabled\": true,\n \"triggersEnabled\": true,\n \"funnelsEnabled\": true,\n \"websitesEnabled\": false,\n \"opportunitiesEnabled\": true,\n \"dashboardStatsEnabled\": true,\n \"bulkRequestsEnabled\": true,\n \"appointmentsEnabled\": true,\n \"reviewsEnabled\": true,\n \"onlineListingsEnabled\": true,\n \"phoneCallEnabled\": true,\n \"conversationsEnabled\": true,\n \"assignedDataOnly\": false,\n \"adwordsReportingEnabled\": false,\n \"membershipEnabled\": false,\n \"facebookAdsReportingEnabled\": false,\n \"attributionsReportingEnabled\": false,\n \"settingsEnabled\": true,\n \"tagsEnabled\": true,\n \"leadValueEnabled\": true,\n \"marketingEnabled\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/users/"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"firstName\": {\n \"message\": \"The first name field is mandatory.\",\n \"rule\": \"required\"\n },\n \"lastName\": {\n \"message\": \"The last name field is mandatory.\",\n \"rule\": \"required\"\n },\n \"email\": {\n \"message\": \"The email field is mandatory.\",\n \"rule\": \"required\"\n },\n \"type\": {\n \"message\": \"The type is mandatory.\",\n \"rule\": \"required\"\n },\n \"role\": {\n \"message\": \"The role is mandatory.\",\n \"rule\": \"required\"\n },\n \"locationIds\": {\n \"message\": \"The location ide must be a array.\",\n \"rule\": \"required\"\n },\n \"permissions\": {\n \"message\": \"Ther permissions field every key must contains only true or false.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"b264ba5b-d9f1-4bc4-9083-8e924e05f22f"},{"name":"/v1/users/location","id":"3e05fe58-d73f-4e3a-b301-917cb60be694","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/users/location","description":"

Get user by location.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","users","location"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[]}},"response":[{"id":"b437a90f-3051-4650-8e08-8d3c5f0e31f8","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/users/location"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"users\": [\n {\n \"id\": \"3g3ltlwEJBoXArLowV3e\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"roles\": {\n \"type\": \"agency\",\n \"role\": \"admin\",\n \"locationIds\": [\n \"C2QujeCh8ZnC7al2InWR\"\n ]\n },\n \"permissions\": {\n \"campaignsEnabled\": true,\n \"campaignsReadOnly\": false,\n \"contactsEnabled\": true,\n \"workflowsEnabled\": true,\n \"triggersEnabled\": true,\n \"funnelsEnabled\": true,\n \"websitesEnabled\": false,\n \"opportunitiesEnabled\": true,\n \"dashboardStatsEnabled\": true,\n \"bulkRequestsEnabled\": true,\n \"appointmentsEnabled\": true,\n \"reviewsEnabled\": true,\n \"onlineListingsEnabled\": true,\n \"phoneCallEnabled\": true,\n \"conversationsEnabled\": true,\n \"assignedDataOnly\": false,\n \"adwordsReportingEnabled\": false,\n \"membershipEnabled\": false,\n \"facebookAdsReportingEnabled\": false,\n \"attributionsReportingEnabled\": false,\n \"settingsEnabled\": true,\n \"tagsEnabled\": true,\n \"leadValueEnabled\": true,\n \"marketingEnabled\": true\n }\n },\n {\n \"id\": \"3g3ltlwEJBoXArLowV3e\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"roles\": {\n \"type\": \"agency\",\n \"role\": \"admin\",\n \"locationIds\": [\n \"C2QujeCh8ZnC7al2InWR\"\n ]\n },\n \"permissions\": {\n \"campaignsEnabled\": true,\n \"campaignsReadOnly\": false,\n \"contactsEnabled\": true,\n \"workflowsEnabled\": true,\n \"triggersEnabled\": true,\n \"funnelsEnabled\": true,\n \"websitesEnabled\": false,\n \"opportunitiesEnabled\": true,\n \"dashboardStatsEnabled\": true,\n \"bulkRequestsEnabled\": true,\n \"appointmentsEnabled\": true,\n \"reviewsEnabled\": true,\n \"onlineListingsEnabled\": true,\n \"phoneCallEnabled\": true,\n \"conversationsEnabled\": true,\n \"assignedDataOnly\": false,\n \"adwordsReportingEnabled\": false,\n \"membershipEnabled\": false,\n \"facebookAdsReportingEnabled\": false,\n \"attributionsReportingEnabled\": false,\n \"settingsEnabled\": true,\n \"tagsEnabled\": true,\n \"leadValueEnabled\": true,\n \"marketingEnabled\": true\n }\n }\n ]\n}"},{"id":"2d66155a-4179-4ce4-839c-a6b23aae1332","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/users/location"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"51c06132-95e1-4260-bc52-5371df2854ca","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/users/location"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"3e05fe58-d73f-4e3a-b301-917cb60be694"},{"name":"/v1/users/lookup","id":"e8dd143f-654f-42a8-a7df-f0db45fe2e1d","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/users/lookup?email=hello@google.com","description":"

Find user by email.

Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys

","urlObject":{"path":["v1","users","lookup"],"host":["https://rest.gohighlevel.com"],"query":[{"description":{"content":"

(Required) Email

\n","type":"text/plain"},"key":"email","value":"hello@google.com"}],"variable":[]}},"response":[{"id":"50ea4ab0-f8bd-4626-9fba-a5f9ae552a8e","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/users/lookup?email=hello@google.com","host":["https://rest.gohighlevel.com"],"path":["v1","users","lookup"],"query":[{"key":"email","value":"hello@google.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"3g3ltlwEJBoXArLowV3e\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"roles\": {\n \"type\": \"agency\",\n \"role\": \"admin\",\n \"locationIds\": [\n \"C2QujeCh8ZnC7al2InWR\"\n ]\n },\n \"permissions\": {\n \"campaignsEnabled\": true,\n \"campaignsReadOnly\": false,\n \"contactsEnabled\": true,\n \"workflowsEnabled\": true,\n \"triggersEnabled\": true,\n \"funnelsEnabled\": true,\n \"websitesEnabled\": false,\n \"opportunitiesEnabled\": true,\n \"dashboardStatsEnabled\": true,\n \"bulkRequestsEnabled\": true,\n \"appointmentsEnabled\": true,\n \"reviewsEnabled\": true,\n \"onlineListingsEnabled\": true,\n \"phoneCallEnabled\": true,\n \"conversationsEnabled\": true,\n \"assignedDataOnly\": false,\n \"adwordsReportingEnabled\": false,\n \"membershipEnabled\": false,\n \"facebookAdsReportingEnabled\": false,\n \"attributionsReportingEnabled\": false,\n \"settingsEnabled\": true,\n \"tagsEnabled\": true,\n \"leadValueEnabled\": true,\n \"marketingEnabled\": true\n }\n}"},{"id":"b008cebd-ec2b-4cd5-964e-7a102020d5db","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/users/lookup?email=hello@google.com","host":["https://rest.gohighlevel.com"],"path":["v1","users","lookup"],"query":[{"key":"email","value":"hello@google.com"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"ce6d9946-9703-420a-b11b-59464d1a83c6","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/users/lookup?email=hello@google.com","host":["https://rest.gohighlevel.com"],"path":["v1","users","lookup"],"query":[{"key":"email","value":"hello@google.com"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"e8dd143f-654f-42a8-a7df-f0db45fe2e1d"},{"name":"/v1/users/:userId","id":"48db5f50-2337-4db5-bf3c-3f41b5c779ec","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/users/:userId","description":"

Get agency by user id.

Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys

","urlObject":{"path":["v1","users",":userId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"76ccc67d-5473-450d-80d6-34660058feaf","description":{"content":"

(Required) User Id

\n","type":"text/plain"},"type":"any","value":"082goXVW3lIExEQPOnd3","key":"userId"}]}},"response":[{"id":"5fac2043-8906-47bb-ab23-6ad402c4a67c","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/users/:userId","host":["https://rest.gohighlevel.com"],"path":["v1","users",":userId"],"variable":[{"key":"userId","value":"082goXVW3lIExEQPOnd3","description":"(Required) User Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"3g3ltlwEJBoXArLowV3e\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"roles\": {\n \"type\": \"agency\",\n \"role\": \"admin\",\n \"locationIds\": [\n \"C2QujeCh8ZnC7al2InWR\"\n ]\n },\n \"permissions\": {\n \"campaignsEnabled\": true,\n \"campaignsReadOnly\": false,\n \"contactsEnabled\": true,\n \"workflowsEnabled\": true,\n \"triggersEnabled\": true,\n \"funnelsEnabled\": true,\n \"websitesEnabled\": false,\n \"opportunitiesEnabled\": true,\n \"dashboardStatsEnabled\": true,\n \"bulkRequestsEnabled\": true,\n \"appointmentsEnabled\": true,\n \"reviewsEnabled\": true,\n \"onlineListingsEnabled\": true,\n \"phoneCallEnabled\": true,\n \"conversationsEnabled\": true,\n \"assignedDataOnly\": false,\n \"adwordsReportingEnabled\": false,\n \"membershipEnabled\": false,\n \"facebookAdsReportingEnabled\": false,\n \"attributionsReportingEnabled\": false,\n \"settingsEnabled\": true,\n \"tagsEnabled\": true,\n \"leadValueEnabled\": true,\n \"marketingEnabled\": true\n }\n}"},{"id":"336484d1-0913-4604-abf9-937a72854189","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/users/:userId","host":["https://rest.gohighlevel.com"],"path":["v1","users",":userId"],"variable":[{"key":"userId","value":"082goXVW3lIExEQPOnd3","description":"(Required) User Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"ec0d809f-fb1c-4f76-aae9-48e1ad99a10e","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/users/:userId","host":["https://rest.gohighlevel.com"],"path":["v1","users",":userId"],"variable":[{"key":"userId","value":"082goXVW3lIExEQPOnd3","description":"(Required) User Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"48db5f50-2337-4db5-bf3c-3f41b5c779ec"},{"name":"/v1/users/:userId","id":"0db0bb69-3866-40e4-bbb9-81e4e2f4d8fc","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"password\": \"*******\",\n \"type\": \"account\",\n \"role\": \"admin\",\n \"locationIds\": [\n \"C2QujeCh8ZnC7al2InWR\"\n ],\n \"permissions\": {\n \"campaignsEnabled\": true,\n \"campaignsReadOnly\": false,\n \"contactsEnabled\": true,\n \"workflowsEnabled\": true,\n \"triggersEnabled\": true,\n \"funnelsEnabled\": true,\n \"websitesEnabled\": false,\n \"opportunitiesEnabled\": true,\n \"dashboardStatsEnabled\": true,\n \"bulkRequestsEnabled\": true,\n \"appointmentsEnabled\": true,\n \"reviewsEnabled\": true,\n \"onlineListingsEnabled\": true,\n \"phoneCallEnabled\": true,\n \"conversationsEnabled\": true,\n \"assignedDataOnly\": false,\n \"adwordsReportingEnabled\": false,\n \"membershipEnabled\": false,\n \"facebookAdsReportingEnabled\": false,\n \"attributionsReportingEnabled\": false,\n \"settingsEnabled\": true,\n \"tagsEnabled\": true,\n \"leadValueEnabled\": true,\n \"marketingEnabled\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/users/:userId","description":"

Update a User.

Small description for the field allow options.

type fields will allow these options:

  • account
  • agency

role fields will allow these options:

  • admin
  • user

locationIds fields will allow valid locations id of the agency.

Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys

","urlObject":{"path":["v1","users",":userId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"55d2e2c4-7028-45f6-aa56-92080521aa32","description":{"content":"

(Required) User Id

\n","type":"text/plain"},"type":"any","value":"082goXVW3lIExEQPOnd3","key":"userId"}]}},"response":[{"id":"0792f028-7875-40cd-87fa-22bba45460e0","name":"Successful response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"password\": \"*******\",\n \"type\": \"account\",\n \"role\": \"admin\",\n \"locationIds\": [\n \"C2QujeCh8ZnC7al2InWR\"\n ],\n \"permissions\": {\n \"campaignsEnabled\": true,\n \"campaignsReadOnly\": false,\n \"contactsEnabled\": true,\n \"workflowsEnabled\": true,\n \"triggersEnabled\": true,\n \"funnelsEnabled\": true,\n \"websitesEnabled\": false,\n \"opportunitiesEnabled\": true,\n \"dashboardStatsEnabled\": true,\n \"bulkRequestsEnabled\": true,\n \"appointmentsEnabled\": true,\n \"reviewsEnabled\": true,\n \"onlineListingsEnabled\": true,\n \"phoneCallEnabled\": true,\n \"conversationsEnabled\": true,\n \"assignedDataOnly\": false,\n \"adwordsReportingEnabled\": false,\n \"membershipEnabled\": false,\n \"facebookAdsReportingEnabled\": false,\n \"attributionsReportingEnabled\": false,\n \"settingsEnabled\": true,\n \"tagsEnabled\": true,\n \"leadValueEnabled\": true,\n \"marketingEnabled\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/users/:userId","host":["https://rest.gohighlevel.com"],"path":["v1","users",":userId"],"variable":[{"key":"userId","value":"082goXVW3lIExEQPOnd3","description":"(Required) User Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"3g3ltlwEJBoXArLowV3e\",\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"roles\": {\n \"type\": \"agency\",\n \"role\": \"admin\",\n \"locationIds\": [\n \"C2QujeCh8ZnC7al2InWR\"\n ]\n },\n \"permissions\": {\n \"campaignsEnabled\": true,\n \"campaignsReadOnly\": false,\n \"contactsEnabled\": true,\n \"workflowsEnabled\": true,\n \"triggersEnabled\": true,\n \"funnelsEnabled\": true,\n \"websitesEnabled\": false,\n \"opportunitiesEnabled\": true,\n \"dashboardStatsEnabled\": true,\n \"bulkRequestsEnabled\": true,\n \"appointmentsEnabled\": true,\n \"reviewsEnabled\": true,\n \"onlineListingsEnabled\": true,\n \"phoneCallEnabled\": true,\n \"conversationsEnabled\": true,\n \"assignedDataOnly\": false,\n \"adwordsReportingEnabled\": false,\n \"membershipEnabled\": false,\n \"facebookAdsReportingEnabled\": false,\n \"attributionsReportingEnabled\": false,\n \"settingsEnabled\": true,\n \"tagsEnabled\": true,\n \"leadValueEnabled\": true,\n \"marketingEnabled\": true\n }\n}"},{"id":"2206d79b-2934-43ff-9e83-96ecbd7842dd","name":"Bad Request. please contact support!","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"password\": \"*******\",\n \"type\": \"account\",\n \"role\": \"admin\",\n \"locationIds\": [\n \"C2QujeCh8ZnC7al2InWR\"\n ],\n \"permissions\": {\n \"campaignsEnabled\": true,\n \"campaignsReadOnly\": false,\n \"contactsEnabled\": true,\n \"workflowsEnabled\": true,\n \"triggersEnabled\": true,\n \"funnelsEnabled\": true,\n \"websitesEnabled\": false,\n \"opportunitiesEnabled\": true,\n \"dashboardStatsEnabled\": true,\n \"bulkRequestsEnabled\": true,\n \"appointmentsEnabled\": true,\n \"reviewsEnabled\": true,\n \"onlineListingsEnabled\": true,\n \"phoneCallEnabled\": true,\n \"conversationsEnabled\": true,\n \"assignedDataOnly\": false,\n \"adwordsReportingEnabled\": false,\n \"membershipEnabled\": false,\n \"facebookAdsReportingEnabled\": false,\n \"attributionsReportingEnabled\": false,\n \"settingsEnabled\": true,\n \"tagsEnabled\": true,\n \"leadValueEnabled\": true,\n \"marketingEnabled\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/users/:userId","host":["https://rest.gohighlevel.com"],"path":["v1","users",":userId"],"variable":[{"key":"userId","value":"082goXVW3lIExEQPOnd3","description":"(Required) User Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"16edce08-727b-486f-8fb8-1565805460a0","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"password\": \"*******\",\n \"type\": \"account\",\n \"role\": \"admin\",\n \"locationIds\": [\n \"C2QujeCh8ZnC7al2InWR\"\n ],\n \"permissions\": {\n \"campaignsEnabled\": true,\n \"campaignsReadOnly\": false,\n \"contactsEnabled\": true,\n \"workflowsEnabled\": true,\n \"triggersEnabled\": true,\n \"funnelsEnabled\": true,\n \"websitesEnabled\": false,\n \"opportunitiesEnabled\": true,\n \"dashboardStatsEnabled\": true,\n \"bulkRequestsEnabled\": true,\n \"appointmentsEnabled\": true,\n \"reviewsEnabled\": true,\n \"onlineListingsEnabled\": true,\n \"phoneCallEnabled\": true,\n \"conversationsEnabled\": true,\n \"assignedDataOnly\": false,\n \"adwordsReportingEnabled\": false,\n \"membershipEnabled\": false,\n \"facebookAdsReportingEnabled\": false,\n \"attributionsReportingEnabled\": false,\n \"settingsEnabled\": true,\n \"tagsEnabled\": true,\n \"leadValueEnabled\": true,\n \"marketingEnabled\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/users/:userId","host":["https://rest.gohighlevel.com"],"path":["v1","users",":userId"],"variable":[{"key":"userId","value":"082goXVW3lIExEQPOnd3","description":"(Required) User Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"4a117263-81f7-4f5d-b3a3-b16faa73e21b","name":"Unprocessable Entity","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"firstName\": \"John\",\n \"lastName\": \"Deo\",\n \"email\": \"john@deo.com\",\n \"password\": \"*******\",\n \"type\": \"account\",\n \"role\": \"admin\",\n \"locationIds\": [\n \"C2QujeCh8ZnC7al2InWR\"\n ],\n \"permissions\": {\n \"campaignsEnabled\": true,\n \"campaignsReadOnly\": false,\n \"contactsEnabled\": true,\n \"workflowsEnabled\": true,\n \"triggersEnabled\": true,\n \"funnelsEnabled\": true,\n \"websitesEnabled\": false,\n \"opportunitiesEnabled\": true,\n \"dashboardStatsEnabled\": true,\n \"bulkRequestsEnabled\": true,\n \"appointmentsEnabled\": true,\n \"reviewsEnabled\": true,\n \"onlineListingsEnabled\": true,\n \"phoneCallEnabled\": true,\n \"conversationsEnabled\": true,\n \"assignedDataOnly\": false,\n \"adwordsReportingEnabled\": false,\n \"membershipEnabled\": false,\n \"facebookAdsReportingEnabled\": false,\n \"attributionsReportingEnabled\": false,\n \"settingsEnabled\": true,\n \"tagsEnabled\": true,\n \"leadValueEnabled\": true,\n \"marketingEnabled\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/users/:userId","host":["https://rest.gohighlevel.com"],"path":["v1","users",":userId"],"variable":[{"key":"userId","value":"082goXVW3lIExEQPOnd3","description":"(Required) User Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"firstName\": {\n \"message\": \"The first name field is mandatory.\",\n \"rule\": \"required\"\n },\n \"lastName\": {\n \"message\": \"The last name field is mandatory.\",\n \"rule\": \"required\"\n },\n \"email\": {\n \"message\": \"The email field is mandatory.\",\n \"rule\": \"required\"\n },\n \"type\": {\n \"message\": \"The type is mandatory.\",\n \"rule\": \"required\"\n },\n \"role\": {\n \"message\": \"The role is mandatory.\",\n \"rule\": \"required\"\n },\n \"locationIds\": {\n \"message\": \"The location ide must be a array.\",\n \"rule\": \"required\"\n },\n \"permissions\": {\n \"message\": \"Ther permissions field every key must contains only true or false.\",\n \"rule\": \"required\"\n }\n}"}],"_postman_id":"0db0bb69-3866-40e4-bbb9-81e4e2f4d8fc"},{"name":"/v1/users/:userId","id":"55d81f6a-32c5-459d-8485-322ff320cb79","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"DELETE","header":[],"url":"https://rest.gohighlevel.com/v1/users/:userId","description":"

Delete one of user.Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys

\n","urlObject":{"path":["v1","users",":userId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"52baa942-6a4d-4e55-9139-0901daa78511","description":{"content":"

(Required) User Id

\n","type":"text/plain"},"type":"any","value":"082goXVW3lIExEQPOnd3","key":"userId"}]}},"response":[{"id":"578e4d2d-fd80-4911-b6af-1729610eab70","name":"Successful response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/users/:userId","host":["https://rest.gohighlevel.com"],"path":["v1","users",":userId"],"variable":[{"key":"userId","value":"082goXVW3lIExEQPOnd3","description":"(Required) User Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"\"\""},{"id":"4652ba31-69a3-46eb-8bcd-da99083df1ed","name":"Bad Request. please contact support!","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/users/:userId","host":["https://rest.gohighlevel.com"],"path":["v1","users",":userId"],"variable":[{"key":"userId","value":"082goXVW3lIExEQPOnd3","description":"(Required) User Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"6dbe951c-35e2-4648-acaf-e59f1b4d7216","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/users/:userId","host":["https://rest.gohighlevel.com"],"path":["v1","users",":userId"],"variable":[{"key":"userId","value":"082goXVW3lIExEQPOnd3","description":"(Required) User Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"55d81f6a-32c5-459d-8485-322ff320cb79"}],"id":"0c772663-3848-4368-a30e-ce350982d81d","_postman_id":"0c772663-3848-4368-a30e-ce350982d81d","description":"","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","name":"GoHighLevel API V1.1.20","type":"collection"}}},{"name":"Saas","item":[{"name":"/v1/saas/locations","id":"b9e0ca1e-9bf1-402e-a649-3166b4e5136a","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/saas/locations?customerId=cus_xxxxxxxxxx&subscriptionId=sub_xxxxxxxxxxxx","description":"

Get saas locations.

Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys

","urlObject":{"path":["v1","saas","locations"],"host":["https://rest.gohighlevel.com"],"query":[{"description":{"content":"

Customer Id

\n","type":"text/plain"},"key":"customerId","value":"cus_xxxxxxxxxx"},{"description":{"content":"

Subscription Id (optional)

\n","type":"text/plain"},"key":"subscriptionId","value":"sub_xxxxxxxxxxxx"}],"variable":[]}},"response":[{"id":"611192a9-8bea-4206-8893-2e8ea7ef289c","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/saas/locations?customerId=cus_xxxxxxxxxx&subscriptionId=sub_xxxxxxxxxxxx","host":["https://rest.gohighlevel.com"],"path":["v1","saas","locations"],"query":[{"key":"customerId","value":"cus_xxxxxxxxxx"},{"key":"subscriptionId","value":"sub_xxxxxxxxxxxx"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"locationIds\": [\n \"F6V8F8Nxxxxxxxx\",\n \"F6V8F8Nxxxxxxxx\"\n ]\n}"},{"id":"5f3abfab-c90f-4498-ab2c-3607a76c0ad2","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/saas/locations?customerId=cus_xxxxxxxxxx&subscriptionId=sub_xxxxxxxxxxxx","host":["https://rest.gohighlevel.com"],"path":["v1","saas","locations"],"query":[{"key":"customerId","value":"cus_xxxxxxxxxx"},{"key":"subscriptionId","value":"sub_xxxxxxxxxxxx"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"41ec0875-eadd-40a5-883d-f2a8abcb12ce","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/saas/locations?customerId=cus_xxxxxxxxxx&subscriptionId=sub_xxxxxxxxxxxx","host":["https://rest.gohighlevel.com"],"path":["v1","saas","locations"],"query":[{"key":"customerId","value":"cus_xxxxxxxxxx"},{"key":"subscriptionId","value":"sub_xxxxxxxxxxxx"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"ec3a3357-764e-413f-80cd-496e6dde15fd","name":"Unprocessable Entity","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/saas/locations?customerId=cus_xxxxxxxxxx&subscriptionId=sub_xxxxxxxxxxxx","host":["https://rest.gohighlevel.com"],"path":["v1","saas","locations"],"query":[{"key":"customerId","value":"cus_xxxxxxxxxx"},{"key":"subscriptionId","value":"sub_xxxxxxxxxxxx"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"customerId\": {\n \"message\": \"The customerId field is mandatory.\",\n \"rule\": \"requiredWithout\"\n },\n \"subscriptionId\": {\n \"message\": \"The subscriptionId field is mandatory.\",\n \"rule\": \"requiredWithout\"\n }\n}"}],"_postman_id":"b9e0ca1e-9bf1-402e-a649-3166b4e5136a"},{"name":"/v1/saas/update-saas-subscription/:locationId","id":"9108e72d-7804-47f7-a6d7-1dbad07cc66e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customerId\": \"cus_KXxx1xxxx\",\n \"subscriptionId\": \"sub_1K9Rksxxxxx\"\n}","options":{"raw":{"language":"json"}}},"url":"https://rest.gohighlevel.com/v1/saas/update-saas-subscription/:locationId","description":"

Update saas subscription.

Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys

","urlObject":{"path":["v1","saas","update-saas-subscription",":locationId"],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[{"id":"da119c38-4cab-4ff2-b23a-88d8f29dc028","description":{"content":"

(Required) Location Id

\n","type":"text/plain"},"type":"any","value":"KXD1dw233GU1Zrvyp","key":"locationId"}]}},"response":[{"id":"bc10969b-0eb8-4161-8f34-bf7a514158a4","name":"Successful response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"customerId\": \"cus_KXxx1xxxx\",\n \"subscriptionId\": \"sub_1K9Rksxxxxx\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/saas/update-saas-subscription/:locationId","host":["https://rest.gohighlevel.com"],"path":["v1","saas","update-saas-subscription",":locationId"],"variable":[{"key":"locationId","value":"KXD1dw233GU1Zrvyp","description":"(Required) Location Id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"locationIds\": [\n \"F6V8F8Nxxxxxxxx\",\n \"F6V8F8Nxxxxxxxx\"\n ]\n}"},{"id":"097733d7-72e3-4c82-95cf-aaabbc49c218","name":"Bad Request. please contact support!","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"customerId\": \"cus_KXxx1xxxx\",\n \"subscriptionId\": \"sub_1K9Rksxxxxx\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/saas/update-saas-subscription/:locationId","host":["https://rest.gohighlevel.com"],"path":["v1","saas","update-saas-subscription",":locationId"],"variable":[{"key":"locationId","value":"KXD1dw233GU1Zrvyp","description":"(Required) Location Id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"2dcb3736-52d8-4c83-8727-c4e50f26ce49","name":"Unauthorized","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"customerId\": \"cus_KXxx1xxxx\",\n \"subscriptionId\": \"sub_1K9Rksxxxxx\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/saas/update-saas-subscription/:locationId","host":["https://rest.gohighlevel.com"],"path":["v1","saas","update-saas-subscription",":locationId"],"variable":[{"key":"locationId","value":"KXD1dw233GU1Zrvyp","description":"(Required) Location Id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"},{"id":"1fd5ace6-a28c-4e59-8048-04d868dd6275","name":"Unprocessable Entity","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"body":{"mode":"raw","raw":"{\n \"customerId\": \"cus_KXxx1xxxx\",\n \"subscriptionId\": \"sub_1K9Rksxxxxx\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://rest.gohighlevel.com/v1/saas/update-saas-subscription/:locationId","host":["https://rest.gohighlevel.com"],"path":["v1","saas","update-saas-subscription",":locationId"],"variable":[{"key":"locationId","value":"KXD1dw233GU1Zrvyp","description":"(Required) Location Id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"customerId\": {\n \"message\": \"The customerId field is mandatory.\",\n \"rule\": \"requiredWithout\"\n },\n \"subscriptionId\": {\n \"message\": \"The subscriptionId field is mandatory.\",\n \"rule\": \"requiredWithout\"\n }\n}"}],"_postman_id":"9108e72d-7804-47f7-a6d7-1dbad07cc66e"}],"id":"5e2c18d2-4dac-4631-9b88-b7b915f84c44","_postman_id":"5e2c18d2-4dac-4631-9b88-b7b915f84c44","description":"","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","name":"GoHighLevel API V1.1.20","type":"collection"}}},{"name":"Snapshot","item":[{"name":"/v1/snapshots/","id":"1cb64abe-8f62-4729-ba19-9fda38ec9552","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/snapshots/","description":"

Get all snapshots.

Authorization:

Provide your agency api key (Bearer Token). You can find it on Agency -> Settings -> API keys

","urlObject":{"path":["v1","snapshots",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[]}},"response":[{"id":"d17b7327-e313-457d-8a6f-9284ea63f905","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/snapshots/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"snapshots\": [\n {\n \"id\": \"1eM2UgkfaECOYyUdCo9P\",\n \"name\": \"Martial Arts Snapshot\",\n \"type\": \"vertical\"\n },\n {\n \"id\": \"1eM2UgkfaECOYyUdCo9P\",\n \"name\": \"Martial Arts Snapshot\",\n \"type\": \"vertical\"\n }\n ]\n}"},{"id":"ca5f1b61-541b-4a67-80aa-4b46af69a546","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/snapshots/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"09fc0a4e-489c-4494-b7a6-5ef9d83b06d4","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/snapshots/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"1cb64abe-8f62-4729-ba19-9fda38ec9552"}],"id":"da3ab614-ae8f-4dcc-9084-4e86fb8c7f51","_postman_id":"da3ab614-ae8f-4dcc-9084-4e86fb8c7f51","description":"","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","name":"GoHighLevel API V1.1.20","type":"collection"}}},{"name":"Survey","item":[{"name":"/v1/surveys/","id":"0a470221-8707-4d24-8d9c-4010341490e1","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/surveys/","description":"

Get Surveys.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","surveys",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[]}},"response":[{"id":"9c0f16f7-9b9e-4d42-bae9-bebea53c50ab","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/surveys/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"surveys\": [\n {\n \"id\": \"8qS1AwSo1k0536WJu9kk\",\n \"name\": \"Survey 1\"\n },\n {\n \"id\": \"8qS1AwSo1k0536WJu9kk\",\n \"name\": \"Survey 1\"\n }\n ]\n}"},{"id":"e2cf4d08-9fef-4fe1-bd55-417a4a3907a9","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/surveys/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"681a0ab3-a299-4a02-bf7f-0f46a359c5c2","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/surveys/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"0a470221-8707-4d24-8d9c-4010341490e1"},{"name":"/v1/surveys/submissions","id":"ab491ae1-6978-4663-9666-bd9359b0eb91","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/surveys/submissions?page=1&limit=20&surveyId=jjusM6EOngDExnbo2DbU&q=john@deo.com&startAt=2020-11-14&endAt=2020-12-14","description":"

Get survey submissions.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","surveys","submissions"],"host":["https://rest.gohighlevel.com"],"query":[{"description":{"content":"

Page No. By default it will be 1

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Limit Per Page records count. will allow maximum up to 100 and default will be 20

\n","type":"text/plain"},"key":"limit","value":"20"},{"description":{"content":"

Filter submission by survey id

\n","type":"text/plain"},"key":"surveyId","value":"jjusM6EOngDExnbo2DbU"},{"description":{"content":"

Filter by contactId, name, email or phone no.

\n","type":"text/plain"},"key":"q","value":"john@deo.com"},{"description":{"content":"

Get submission by starting of this date. By default it will be same date of last month.

\n","type":"text/plain"},"key":"startAt","value":"2020-11-14"},{"description":{"content":"

Get submission by ending of this date. By default it will be current date.

\n","type":"text/plain"},"key":"endAt","value":"2020-12-14"}],"variable":[]}},"response":[{"id":"59ae73a3-75d1-4ab5-a1f1-a4c8d69795a1","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/surveys/submissions?page=1&limit=20&surveyId=jjusM6EOngDExnbo2DbU&q=john@deo.com&startAt=2020-11-14&endAt=2020-12-14","host":["https://rest.gohighlevel.com"],"path":["v1","surveys","submissions"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"20"},{"key":"surveyId","value":"jjusM6EOngDExnbo2DbU"},{"key":"q","value":"john@deo.com"},{"key":"startAt","value":"2020-11-14"},{"key":"endAt","value":"2020-12-14"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"submissions\": [\n {\n \"id\": \"be759b9a-c3ec-4b29-ba07-fc3c89c77673\",\n \"contactId\": \"9NkT25Vor1v4aQatFsv2\",\n \"__submissions_other_field__\": \"john@deo.com\",\n \"__custom_field_id__\": \"20\",\n \"createdAt\": \"2020-11-01T18:02:21.000Z\",\n \"surveyId\": \"jjusM6EOngDExnbo2DbU\",\n \"pageDetails\": {\n \"url\": \"https://www.gohighlevel.com/\",\n \"source\": \"Social Media\",\n \"referrer\": \"http://m.facebook.com\",\n \"fbclid\": \"IwAR1JoTTltt3EKJE3O-MrQij_lTeA6BKGTy8M2wKepSzs4oUbTYhL2Lns18w\"\n }\n },\n {\n \"id\": \"be759b9a-c3ec-4b29-ba07-fc3c89c77673\",\n \"contactId\": \"9NkT25Vor1v4aQatFsv2\",\n \"__submissions_other_field__\": \"john@deo.com\",\n \"__custom_field_id__\": \"20\",\n \"createdAt\": \"2020-11-01T18:02:21.000Z\",\n \"surveyId\": \"jjusM6EOngDExnbo2DbU\",\n \"pageDetails\": {\n \"url\": \"https://www.gohighlevel.com/\",\n \"source\": \"Social Media\",\n \"referrer\": \"http://m.facebook.com\",\n \"fbclid\": \"IwAR1JoTTltt3EKJE3O-MrQij_lTeA6BKGTy8M2wKepSzs4oUbTYhL2Lns18w\"\n }\n }\n ],\n \"meta\": {\n \"total\": 250,\n \"currentPage\": 2,\n \"nextPage\": 3,\n \"prevPage\": 1\n }\n}"},{"id":"57be174c-931a-4ffe-9303-475e3669fb13","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/surveys/submissions?page=1&limit=20&surveyId=jjusM6EOngDExnbo2DbU&q=john@deo.com&startAt=2020-11-14&endAt=2020-12-14","host":["https://rest.gohighlevel.com"],"path":["v1","surveys","submissions"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"20"},{"key":"surveyId","value":"jjusM6EOngDExnbo2DbU"},{"key":"q","value":"john@deo.com"},{"key":"startAt","value":"2020-11-14"},{"key":"endAt","value":"2020-12-14"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"64710817-9dd4-4a06-b5dc-ed7e5072974f","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":{"raw":"https://rest.gohighlevel.com/v1/surveys/submissions?page=1&limit=20&surveyId=jjusM6EOngDExnbo2DbU&q=john@deo.com&startAt=2020-11-14&endAt=2020-12-14","host":["https://rest.gohighlevel.com"],"path":["v1","surveys","submissions"],"query":[{"key":"page","value":"1"},{"key":"limit","value":"20"},{"key":"surveyId","value":"jjusM6EOngDExnbo2DbU"},{"key":"q","value":"john@deo.com"},{"key":"startAt","value":"2020-11-14"},{"key":"endAt","value":"2020-12-14"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"ab491ae1-6978-4663-9666-bd9359b0eb91"}],"id":"8baa2771-ad02-4bfa-8765-4012e6d4350b","_postman_id":"8baa2771-ad02-4bfa-8765-4012e6d4350b","description":"","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","name":"GoHighLevel API V1.1.20","type":"collection"}}},{"name":"Workflow","item":[{"name":"/v1/workflows/","id":"952d6837-c8ca-4ee2-8635-15a9b6de8127","request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[],"url":"https://rest.gohighlevel.com/v1/workflows/","description":"

Get Workflow.

Authorization:

Provide your location api key (Bearer Token). You can find here

","urlObject":{"path":["v1","workflows",""],"host":["https://rest.gohighlevel.com"],"query":[],"variable":[]}},"response":[{"id":"01a10cf7-13c6-4167-9510-44f1dbad9b56","name":"Successful response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/workflows/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"workflow\": [\n {\n \"id\": \"78559bb3-b920-461e-b010-7b2a2816d2a9\",\n \"name\": \"First Workflow\",\n \"status\": \"draft\",\n \"version\": 2,\n \"createdAt\": \"2021-05-26T11:33:49.000Z\",\n \"updatedAt\": \"2021-05-26T11:33:49.000Z\"\n },\n {\n \"id\": \"78559bb3-b920-461e-b010-7b2a2816d2a9\",\n \"name\": \"First Workflow\",\n \"status\": \"draft\",\n \"version\": 2,\n \"createdAt\": \"2021-05-26T11:33:49.000Z\",\n \"updatedAt\": \"2021-05-26T11:33:49.000Z\"\n }\n ]\n}"},{"id":"c749b215-ff3d-434a-baea-b2cae8b5cfae","name":"Bad Request. please contact support!","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/workflows/"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Bad Request\"\n}"},{"id":"ac4d74ec-dbde-410f-b8ca-a0157cf6efff","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer "}],"url":"https://rest.gohighlevel.com/v1/workflows/"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Unauthorized\"\n}"}],"_postman_id":"952d6837-c8ca-4ee2-8635-15a9b6de8127"}],"id":"deaa9e07-a438-4e73-b47b-92a7326ba926","_postman_id":"deaa9e07-a438-4e73-b47b-92a7326ba926","description":"","auth":{"type":"bearer","bearer":{"token":""},"isInherited":true,"source":{"_postman_id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","id":"81ab1e0e-f09e-4771-a54b-be56ecdde267","name":"GoHighLevel API V1.1.20","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"token":""}},"variable":[{"id":"4504b143-9024-4d24-9798-1604e2423412","key":"baseUrl","value":"https://rest.gohighlevel.com","type":"string"}]}