Associations
Associations API
Documentación de la API de Associations
Servidor base: https://services.leadconnectorhq.com
Endpoints
- POST /associations/relations — Crear Relation for you associated entities.
- GET /associations/relations/{recordId} — Obtener todos los relations By record Id
- DELETE /associations/relations/{relationId} — Eliminar relacion
- GET /associations/key/{key_name} — Obtener association key by key name
- GET /associations/objectKey/{objectKey} — Obtener association by object keys
- PUT /associations/{associationId} — Actualizar Association By Id
- DELETE /associations/{associationId} — Eliminar asociacion
- GET /associations/{associationId} — Obtener association by Id
- POST /associations/ — Crear asociacion
- GET /associations/ — Obtener todos los associations for a sub-account / location
POST /associations/relations
Crear Relation for you associated entities. Create Relation.Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3
Scopes requeridos: associations/relation.write
Parametros:
- Versión (header, string) (requerido) — Versión de la API
Cuerpo de la peticion (application/json):
- locationId (requerido) — string — Your Sub Account's Id
- associationId (requerido) — string — Association's Id
- firstRecordId (requerido) — string — First Record's Id. For instance, if you have an association between a contact and a custom object, and you specify the contact as the first object while creating the association, then your firstRecordId would be the contactId
- secondRecordId (requerido) — string — Second Record's Id.For instance, if you have an association between a contact and a custom object, and you specify the custom object as the second entity while creating the association, then your secondRecordId would be the customObject record Id
Respuestas:
- 201 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
GET /associations/relations/{recordId}
Obtener todos los relations By record Id Get all relations by record Id
Scopes requeridos: associations/relation.readonly
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- recordId (path, string) (requerido) —
- locationId (query, string) (requerido) — Your Sub Account's Id
- skip (query, number) (requerido) —
- limit (query, number) (requerido) —
- associationIds (query, array) — Association Ids
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
DELETE /associations/relations/{relationId}
Eliminar relacion Scopes requeridos: associations/relation.write
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- relationId (path, string) (requerido) —
- locationId (query, string) (requerido) — Your Sub Account's Id
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
GET /associations/key/{key_name}
Obtener association key by key name Using this api you can get standard / user defined association by key
Scopes requeridos: associations.readonly
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- key_name (path, string) (requerido) —
- locationId (query, string) (requerido) —
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
GET /associations/objectKey/{objectKey}
Obtener association by object keys Get association by object keys like contacts, custom objects and opportunities. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3
Scopes requeridos: associations.readonly
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- objectKey (path, string) —
- locationId (query, string) —
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
PUT /associations/{associationId}
Actualizar Association By Id Update Association , Allows you to update labels of an associations. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3
Scopes requeridos: associations.write
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- associationId (path, string) (requerido) —
Cuerpo de la peticion (application/json):
- firstObjectLabel (requerido) — object
- secondObjectLabel (requerido) — object
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
DELETE /associations/{associationId}
Eliminar asociacion Delete USER_DEFINED Association By Id, deleting an association will also all the relations for that association
Scopes requeridos: associations.write
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- associationId (path, string) (requerido) —
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
GET /associations/{associationId}
Obtener association by Id Using this api you can get SYSTEM_DEFINED / USER_DEFINED association by id
Scopes requeridos: associations.readonly
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- associationId (path, string) (requerido) —
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
POST /associations/
Crear asociacion Allow you to create contact - contact , contact - custom objects associations, will add more in the future.Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3
Scopes requeridos: associations.write
Parametros:
- Versión (header, string) (requerido) — Versión de la API
Cuerpo de la peticion (application/json):
- locationId (requerido) — string
- key (requerido) — string — Association's Unique key
- firstObjectLabel (requerido) — object — First Objects Association Label (custom_objects.children)
- firstObjectKey (requerido) — object — First Objects Key
- secondObjectLabel (requerido) — object — Second Object Association Label (contact)
- secondObjectKey (requerido) — object — Second Objects Key
Respuestas:
- 201 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
GET /associations/
Obtener todos los associations for a sub-account / location Get all Associations
Scopes requeridos: associations.readonly
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- locationId (query, string) (requerido) —
- skip (query, number) (requerido) —
- limit (query, number) (requerido) —
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
