Skip to content
TarekyDocs
Console

A public link following this device to a destination ("track your delivery"); ends on arrival or within 6 h

POST
/v1/tracking/devices/{externalId}/shares
curl --request POST \
  --url https://api.tareky.com/v1/tracking/devices/example/shares \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "destination": { "lng": 1, "lat": 1, "name": "example" }, "locale": "ar", "partnerName": { "ar": "example", "en": "example" } }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
externalId
required
string

Header Parameters

Section titled “Header Parameters”
x-access-key-id
string

Legacy key id (until its sunset)

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
>= 1 characters <= 80 characters
destination
required
object
lng
required
number
>= -180 <= 180
lat
required
number
>= -90 <= 90
name
string
nullable <= 120 characters
locale
string
default: ar
Allowed values: ar en
partnerName
object
ar
string
<= 40 characters
en
string
<= 40 characters

Responses

Section titled “Responses”

429

Section titled “429”

Rate limit or monthly quota exceeded; see Retry-After

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable code, e.g. quota_exceeded, no_route

string
message
required
string
status
required
integer
>= -9007199254740991 <= 9007199254740991
details

For invalid_request: the validation issues

docsUrl
required
string
requestId
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "status": 1,
    "details": "example",
    "docsUrl": "example"
  },
  "requestId": "example"
}

default

Section titled “default”

Any other error, in the /v1 error envelope

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable code, e.g. quota_exceeded, no_route

string
message
required
string
status
required
integer
>= -9007199254740991 <= 9007199254740991
details

For invalid_request: the validation issues

docsUrl
required
string
requestId
string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "status": 1,
    "details": "example",
    "docsUrl": "example"
  },
  "requestId": "example"
}