Daylite WebsiteMarketcircle Blog
API Reference

Role

patch
https://api.marketcircle.net/v1/roles/

Modify a role

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

When Modifying a role, it's essential to incorporate one of the following combinations:
Contact and Company or Opportunity or Project

Company and Contact or Opportunity or Project

Opportunity and Company or Contact

Project and Company or Contact

🚧

Department

The department attribute is only applicable to roles between Contact and Company entities.

Attributes you leave out are not changed. To change the role type, set type; role can't be sent. A role in the trash can't be edited (404 with {"error":"trashed_object"}) until you restore it with {"trashed": false}.

A successful update returns 204 No Content.

Path Params
int32
required

The role ID

Body Params
string

Reference of the contact, e.g. /v1/contacts/1000.

string

Reference of the company, e.g. /v1/companies/1000.

string

Reference of the opportunity, e.g. /v1/opportunities/1000.

string

Reference of the project, e.g. /v1/projects/1000.

string

Reference of the role type, e.g. /v1/role_types/1000. Optional.

string

Title, e.g. a job title (max 128 characters).

string

Department (max 128 characters). Only allowed on roles between a contact and a company.

boolean

Set to false to restore the role from the trash. Use DELETE to move it to the trash.

Responses
204

204 No Content

Updated 13 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 13 days ago