Custom Attributes

Define custom fields for contacts

List custom attributes

get

https://api.gomobile.iohttps://staging-api.gomobile.iohttp://localhost:3000

/custom-attributes

Authorizations

BearerAuth

AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Responses

200

List of custom attributes

application/json

401

Unauthorized

get

/custom-attributes

HTTPcURLJavaScriptPython

GET /custom-attributes HTTP/1.1
Host: api.gomobile.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "displayName": "text",
    "description": "text",
    "type": "text",
    "createdAt": "2025-12-19T15:55:16.031Z",
    "updatedAt": "2025-12-19T15:55:16.031Z"
  }
]

Create custom attribute

post

https://api.gomobile.iohttps://staging-api.gomobile.iohttp://localhost:3000

/custom-attributes

Authorizations

BearerAuth

AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Body

application/json

displayNamestringRequired

descriptionstringOptional

typestring · enumRequiredPossible values:

Responses

201

Custom attribute created

application/json

400

Invalid input

401

Unauthorized

post

/custom-attributes

HTTPcURLJavaScriptPython

POST /custom-attributes HTTP/1.1
Host: api.gomobile.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "displayName": "text",
  "description": "text",
  "type": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "displayName": "text",
  "description": "text",
  "type": "text",
  "createdAt": "2025-12-19T15:55:16.031Z",
  "updatedAt": "2025-12-19T15:55:16.031Z"
}

Get custom attribute

get

https://api.gomobile.iohttps://staging-api.gomobile.iohttp://localhost:3000

/custom-attributes/{customAttributeId}

Authorizations

BearerAuth

AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Path parameters

customAttributeIdstring · uuidRequired

Responses

200

Custom attribute details

application/json

401

Unauthorized

404

Custom attribute not found

get

/custom-attributes/{customAttributeId}

HTTPcURLJavaScriptPython

GET /custom-attributes/{customAttributeId} HTTP/1.1
Host: api.gomobile.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "displayName": "text",
  "description": "text",
  "type": "text",
  "createdAt": "2025-12-19T15:55:16.031Z",
  "updatedAt": "2025-12-19T15:55:16.031Z"
}

Update custom attribute

put

https://api.gomobile.iohttps://staging-api.gomobile.iohttp://localhost:3000

/custom-attributes/{customAttributeId}

Authorizations

BearerAuth

AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Path parameters

customAttributeIdstring · uuidRequired

Body

application/json

descriptionstringOptional

Responses

200

Custom attribute updated

application/json

401

Unauthorized

404

Custom attribute not found

put

/custom-attributes/{customAttributeId}

HTTPcURLJavaScriptPython

PUT /custom-attributes/{customAttributeId} HTTP/1.1
Host: api.gomobile.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 22

{
  "description": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "displayName": "text",
  "description": "text",
  "type": "text",
  "createdAt": "2025-12-19T15:55:16.031Z",
  "updatedAt": "2025-12-19T15:55:16.031Z"
}

Delete custom attribute

delete

https://api.gomobile.iohttps://staging-api.gomobile.iohttp://localhost:3000

/custom-attributes/{customAttributeId}

Authorizations

BearerAuth

AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Path parameters

customAttributeIdstring · uuidRequired

Responses

200

Custom attribute deleted

application/json

401

Unauthorized

404

Custom attribute not found

delete

/custom-attributes/{customAttributeId}

HTTPcURLJavaScriptPython

DELETE /custom-attributes/{customAttributeId} HTTP/1.1
Host: api.gomobile.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "displayName": "text",
  "description": "text",
  "type": "text",
  "createdAt": "2025-12-19T15:55:16.031Z",
  "updatedAt": "2025-12-19T15:55:16.031Z"
}