Label

Create or retrieve a label by name

Gets or creates a label by name.

post/v1/projects/{project_id}/labels

Request

  • Base URL: https://api.telerivet.com
  • URL: https://api.telerivet.com/v1/projects/{project_id}/labels
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://telerivet.com/oauth/authorize, token URL https://api.telerivet.com/oauth/token)

Path parameters

project_idstring required

ID of the Project

Request body

namestring required

Name of the label

Example request

{
  "name": "Important"
}

Response

Successful response

idstring

ID of the label

namestring

Name of the label

time_createdinteger

Time the label was created in Telerivet

varsobject

Custom variables stored for this label. Variable names may be up to 32 characters in length and can contain the characters a-z, A-Z, 0-9, and _. Values may be strings, numbers, or boolean (true/false). String values may be up to 4096 bytes in length when encoded as UTF-8. Up to 100 variables are supported per object. Setting a variable to null will delete the variable.

project_idstring

ID of the project this label belongs to

Example response

{
  "id": "LB4f3dac27154653e0",
  "name": "Important",
  "time_created": 1392254503,
  "project_id": "PJ2ad0100821a98bea"
}

Changes

No recorded changes to this operation across all 1 revision of this API.