Stop location sharing

client.Chats.Location.Stop(ctx, chatID, body) (*StopChatLocationSharingResponse, error)

DELETE/v3/chats/{chatId}/location

Stop a contact’s location share with you. handle is required and names whose share to end.

Returns 202 when the request is accepted. The stop is carried out on the contact’s device, and the location.sharing.stopped webhook fires once sharing has ended.

Sharing is per contact, so this ends that contact’s share in every chat you have with them.

Returns 404 if the contact isn’t currently sharing.

ParametersExpand Collapse

chatID string

formatuuid

body ChatLocationStopParams

Handle param.Field[string]

Phone number (E.164 format) or email address of the contact whose share to end

ReturnsExpand Collapse

type StopChatLocationSharingResponse struct{…}

Message string

Success bool

Stop location sharing

package main

import (
  "context"
  "fmt"

  "github.com/linq-team/linq-go"
  "github.com/linq-team/linq-go/option"
)

func main() {
  client := linqgo.NewClient(
    option.WithAPIKey("My API Key"),
  )
  stopChatLocationSharingResponse, err := client.Chats.Location.Stop(
    context.TODO(),
    "975d0776-bd17-4273-8337-f346b4c661b0",
    linqgo.ChatLocationStopParams{
      Handle: "+15551234567",
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", stopChatLocationSharingResponse.Message)
}

{
  "success": true,
  "message": "Location sharing stop requested"
}

{
  "error": {
    "status": 400,
    "code": 1002,
    "message": "Phone number must be in E.164 format",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/1xxx/1002/"
  },
  "success": false
}

{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/2xxx/2004/"
  },
  "success": false
}

{
  "error": {
    "status": 403,
    "code": 2005,
    "message": "Access denied - insufficient permissions for this resource",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/2xxx/2005/"
  },
  "success": false
}

{
  "error": {
    "status": 404,
    "code": 2001,
    "message": "Resource not found",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/2xxx/2001/"
  },
  "success": false
}

{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/3xxx/3006/"
  },
  "success": false
}

Returns Examples

{
  "success": true,
  "message": "Location sharing stop requested"
}

{
  "error": {
    "status": 400,
    "code": 1002,
    "message": "Phone number must be in E.164 format",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/1xxx/1002/"
  },
  "success": false
}

{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/2xxx/2004/"
  },
  "success": false
}

{
  "error": {
    "status": 403,
    "code": 2005,
    "message": "Access denied - insufficient permissions for this resource",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/2xxx/2005/"
  },
  "success": false
}

{
  "error": {
    "status": 404,
    "code": 2001,
    "message": "Resource not found",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/2xxx/2001/"
  },
  "success": false
}

{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error",
    "doc_url": "https://docs.linqapp.com/channel/imessage/error/codes/3xxx/3006/"
  },
  "success": false
}