Upload new avatar

POST /api-v1/attachment/upload-avatar/{contactId}

Headers

TARGET-ORGANIZATION-ID integer(int32)

ID of organization, for which the operation must be performed
WEAL-TOKEN string Required

API token (can be retrieved from account settings)

Path parameters

contactId integer Required

contactId

Query parameters

httpServletMapping.mappingMatch string

Values are CONTEXT_ROOT, DEFAULT, EXACT, EXTENSION, or PATH.
httpServletMapping.matchValue string
httpServletMapping.pattern string
httpServletMapping.servletName string
note string

note
requestHeaders.ETag string
requestHeaders.acceptCharset[0].registered boolean
requestHeaders.acceptLanguageAsLocales[0].ISO3Country string
requestHeaders.acceptLanguageAsLocales[0].ISO3Language string
requestHeaders.acceptLanguageAsLocales[0].country string
requestHeaders.acceptLanguageAsLocales[0].displayCountry string
requestHeaders.acceptLanguageAsLocales[0].displayLanguage string
requestHeaders.acceptLanguageAsLocales[0].displayName string
requestHeaders.acceptLanguageAsLocales[0].displayScript string
requestHeaders.acceptLanguageAsLocales[0].displayVariant string
requestHeaders.acceptLanguageAsLocales[0].language string
requestHeaders.acceptLanguageAsLocales[0].script string
requestHeaders.acceptLanguageAsLocales[0].unicodeLocaleAttributes array[string]
requestHeaders.acceptLanguageAsLocales[0].unicodeLocaleKeys array[string]
requestHeaders.acceptLanguageAsLocales[0].variant string
requestHeaders.acceptLanguage[0].range string
requestHeaders.acceptLanguage[0].weight number(double)
requestHeaders.acceptPatch[0].charset.registered boolean
requestHeaders.acceptPatch[0].concrete boolean
requestHeaders.acceptPatch[0].qualityValue number(double)
requestHeaders.acceptPatch[0].subtype string
requestHeaders.acceptPatch[0].subtypeSuffix string
requestHeaders.acceptPatch[0].type string
requestHeaders.acceptPatch[0].wildcardSubtype boolean
requestHeaders.acceptPatch[0].wildcardType boolean
requestHeaders.accept[0].charset.registered boolean
requestHeaders.accept[0].concrete boolean
requestHeaders.accept[0].qualityValue number(double)
requestHeaders.accept[0].subtype string
requestHeaders.accept[0].subtypeSuffix string
requestHeaders.accept[0].type string
requestHeaders.accept[0].wildcardSubtype boolean
requestHeaders.accept[0].wildcardType boolean
requestHeaders.accessControlAllowCredentials boolean
requestHeaders.accessControlAllowHeaders array[string]
requestHeaders.accessControlAllowMethods array[string]

Values are GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS, or TRACE.
requestHeaders.accessControlAllowOrigin string
requestHeaders.accessControlExposeHeaders array[string]
requestHeaders.accessControlMaxAge integer(int64)
requestHeaders.accessControlRequestHeaders array[string]
requestHeaders.accessControlRequestMethod string

Values are GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS, or TRACE.
requestHeaders.allow array[string]

Values are GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS, or TRACE.
requestHeaders.cacheControl string
requestHeaders.connection array[string]
requestHeaders.contentDisposition.attachment boolean
requestHeaders.contentDisposition.charset.registered boolean
requestHeaders.contentDisposition.creationDate string(date-time)
requestHeaders.contentDisposition.filename string
requestHeaders.contentDisposition.formData boolean
requestHeaders.contentDisposition.inline boolean
requestHeaders.contentDisposition.modificationDate string(date-time)
requestHeaders.contentDisposition.name string
requestHeaders.contentDisposition.readDate string(date-time)
requestHeaders.contentDisposition.size integer(int64)
requestHeaders.contentDisposition.type string
requestHeaders.contentLanguage.ISO3Country string
requestHeaders.contentLanguage.ISO3Language string
requestHeaders.contentLanguage.country string
requestHeaders.contentLanguage.displayCountry string
requestHeaders.contentLanguage.displayLanguage string
requestHeaders.contentLanguage.displayName string
requestHeaders.contentLanguage.displayScript string
requestHeaders.contentLanguage.displayVariant string
requestHeaders.contentLanguage.language string
requestHeaders.contentLanguage.script string
requestHeaders.contentLanguage.unicodeLocaleAttributes array[string]
requestHeaders.contentLanguage.unicodeLocaleKeys array[string]
requestHeaders.contentLanguage.variant string
requestHeaders.contentLength integer(int64)
requestHeaders.contentType.charset.registered boolean
requestHeaders.contentType.concrete boolean
requestHeaders.contentType.qualityValue number(double)
requestHeaders.contentType.subtype string
requestHeaders.contentType.subtypeSuffix string
requestHeaders.contentType.type string
requestHeaders.contentType.wildcardSubtype boolean
requestHeaders.contentType.wildcardType boolean
requestHeaders.date integer(int64)
requestHeaders.expires integer(int64)
requestHeaders.host.address.MCGlobal boolean
requestHeaders.host.address.MCLinkLocal boolean
requestHeaders.host.address.MCNodeLocal boolean
requestHeaders.host.address.MCOrgLocal boolean
requestHeaders.host.address.MCSiteLocal boolean
requestHeaders.host.address.address string(byte)
requestHeaders.host.address.anyLocalAddress boolean
requestHeaders.host.address.canonicalHostName string
requestHeaders.host.address.hostAddress string
requestHeaders.host.address.hostName string
requestHeaders.host.address.linkLocalAddress boolean
requestHeaders.host.address.loopbackAddress boolean
requestHeaders.host.address.multicastAddress boolean
requestHeaders.host.address.siteLocalAddress boolean
requestHeaders.host.hostName string
requestHeaders.host.hostString string
requestHeaders.host.port integer(int32)
requestHeaders.host.unresolved boolean
requestHeaders.ifMatch array[string]
requestHeaders.ifModifiedSince integer(int64)
requestHeaders.ifNoneMatch array[string]
requestHeaders.ifUnmodifiedSince integer(int64)
requestHeaders.lastModified integer(int64)
requestHeaders.location.absolute boolean
requestHeaders.location.authority string
requestHeaders.location.fragment string
requestHeaders.location.host string
requestHeaders.location.opaque boolean
requestHeaders.location.path string
requestHeaders.location.port integer(int32)
requestHeaders.location.query string
requestHeaders.location.rawAuthority string
requestHeaders.location.rawFragment string
requestHeaders.location.rawPath string
requestHeaders.location.rawQuery string
requestHeaders.location.rawSchemeSpecificPart string
requestHeaders.location.rawUserInfo string
requestHeaders.location.scheme string
requestHeaders.location.schemeSpecificPart string
requestHeaders.location.userInfo string
requestHeaders.origin string
requestHeaders.pragma string
requestHeaders.upgrade string
requestHeaders.vary array[string]
requestMethod string

Values are GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS, or TRACE.
trailerFieldsReady boolean

Responses

200

OK
Hide response attributes Show response attributes object
- content string(byte)
- id integer
- mimeType string
- name string
- remark string
- size integer
400

400 Bad Request
401

401 Unauthorized
403

403 Access Denied
404

404 Not Found
500

500 Internal Server Error

POST /api-v1/attachment/upload-avatar/{contactId}

curl \
 -X POST http://10.10.10.132/api-v1/attachment/upload-avatar/{contactId} \
 -H "TARGET-ORGANIZATION-ID: 42" \
 -H "WEAL-TOKEN: string"

Response examples (200)

{
  "content": "string",
  "id": 42,
  "mimeType": "string",
  "name": "string",
  "remark": "string",
  "size": 42
}