Contacts

Add a contact

POST
/v1/workspaces/{workspace_id}/contacts

To your own list, or with shared to the company’s (for those who manage contacts). An address already there returns that contact unchanged, with 200 rather than 201. Send an Idempotency-Key: the same key returns the same answer for 24 hours.

Authorization

bearer
headerAuthorizationBearer <token>

An access token from /v1/auth/token, or a personal token: opaque, beginning s2a_.

Path Parameters

workspace_id*string

wsp_…, from GET /v1/me

Lengthlength <= 40

Header Parameters

idempotency-key*string

A UUID of your own (ADR 0071 §5)

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Request Body

application/json
  1. body
email*string
Match^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Formatemail
Lengthlength <= 254
first_name?string
Lengthlength <= 80
last_name?string
Lengthlength <= 80
job_title?string
Lengthlength <= 120
phone?string
Lengthlength <= 40
organisation_id?string

org_…

Lengthlength <= 40
shared?boolean

Response Body

Already there

application/json
  1. response

Already there

id*string

con_…

name*string
email*string
job_title*string|null
phone*string|null
organisation*|null
mine*boolean

In your own list rather than the company’s

curl -X POST 'https://api.sign2approve.com/v1/workspaces/string/contacts' \  -H 'idempotency-key: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{  "email": "user@example.com"}'
{  "id": "con_01a16d3fd3507be78e41c4540aa20a3c",  "name": "Pat Client",  "email": "pat@client.example",  "job_title": "Director",  "phone": null,  "organisation": {    "id": "org_01a16d3fd3507be78e41c4540aa20a3d",    "name": "Client Ltd"  },  "mine": true}